Cisco-IOS-XR-ipv4-vrrp-cfg API API Reference

API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
   Key  Mandatory  Optional

Paths

VRRP - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/

Update operation of resource: vrrp

vrrpbody object

Request Content-Types: application/json
Request Example
{      {
        "mac-refresh": "integer",          "reload-delay": "integer",
          "min-delay": "integer"
        },
        "interface-name": "string",          "interval": "integer",
          "detection-multiplier": "integer"
        },              {
                "accept-mode-disable": [ null ],
                "follow": "string",                  "auto-configure": "boolean",
                  "ip-address": "string"
                },
                "slave-virtual-router-id": "integer",                    {
                      "ip-address": "string"
                    }
                  ]
                }
              }
            ]
          },                {                    "auto-configure": "boolean",
                    "ip-address": "string"
                  },
                  "bfd": "string",                      {
                        "priority": "integer",
                        "interface-name": "string"
                      }
                    ]
                  },                    "advertisement-time-in-msec": "integer",
                    "forced": [ null ],
                    "advertisement-time-in-sec": "integer"
                  },                      {
                        "ip-address": "string"
                      }
                    ]
                  },
                  "priority": "integer",                      {
                        "object-name": "string",
                        "priority-decrement": "integer"
                      }
                    ]
                  },
                  "accept-mode-disable": [ null ],
                  "session-name": "string",
                  "vr-id": "integer",
                  "preempt": "integer"
                }
              ]
            }
          }
        },              {
                "accept-mode-disable": [ null ],
                "follow": "string",
                "slave-virtual-router-id": "integer",                    {
                      "ip-address": "string"
                    }
                  ]
                },
                "primary-ipv4-address": "string"
              }
            ]
          },                {                      {
                        "object-name": "string",
                        "priority-decrement": "integer"
                      }
                    ]
                  },
                  "session-name": "string",
                  "bfd": "string",                      {
                        "priority": "integer",
                        "interface-name": "string"
                      }
                    ]
                  },                    "advertisement-time-in-msec": "integer",
                    "forced": [ null ],
                    "advertisement-time-in-sec": "integer"
                  },
                  "primary-ipv4-address": "string",
                  "priority": "integer",
                  "preempt": "integer",                      {
                        "ip-address": "string"
                      }
                    ]
                  },
                  "accept-mode-disable": [ null ],
                  "vr-id": "integer",
                  "text-password": "string"
                }
              ]
            }
          }
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRRP - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/

Create operation of resource: vrrp

vrrpbody object

Request Content-Types: application/json
Request Example
{      {
        "mac-refresh": "integer",          "reload-delay": "integer",
          "min-delay": "integer"
        },
        "interface-name": "string",          "interval": "integer",
          "detection-multiplier": "integer"
        },              {
                "accept-mode-disable": [ null ],
                "follow": "string",                  "auto-configure": "boolean",
                  "ip-address": "string"
                },
                "slave-virtual-router-id": "integer",                    {
                      "ip-address": "string"
                    }
                  ]
                }
              }
            ]
          },                {                    "auto-configure": "boolean",
                    "ip-address": "string"
                  },
                  "bfd": "string",                      {
                        "priority": "integer",
                        "interface-name": "string"
                      }
                    ]
                  },                    "advertisement-time-in-msec": "integer",
                    "forced": [ null ],
                    "advertisement-time-in-sec": "integer"
                  },                      {
                        "ip-address": "string"
                      }
                    ]
                  },
                  "priority": "integer",                      {
                        "object-name": "string",
                        "priority-decrement": "integer"
                      }
                    ]
                  },
                  "accept-mode-disable": [ null ],
                  "session-name": "string",
                  "vr-id": "integer",
                  "preempt": "integer"
                }
              ]
            }
          }
        },              {
                "accept-mode-disable": [ null ],
                "follow": "string",
                "slave-virtual-router-id": "integer",                    {
                      "ip-address": "string"
                    }
                  ]
                },
                "primary-ipv4-address": "string"
              }
            ]
          },                {                      {
                        "object-name": "string",
                        "priority-decrement": "integer"
                      }
                    ]
                  },
                  "session-name": "string",
                  "bfd": "string",                      {
                        "priority": "integer",
                        "interface-name": "string"
                      }
                    ]
                  },                    "advertisement-time-in-msec": "integer",
                    "forced": [ null ],
                    "advertisement-time-in-sec": "integer"
                  },
                  "primary-ipv4-address": "string",
                  "priority": "integer",
                  "preempt": "integer",                      {
                        "ip-address": "string"
                      }
                    ]
                  },
                  "accept-mode-disable": [ null ],
                  "vr-id": "integer",
                  "text-password": "string"
                }
              ]
            }
          }
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRRP - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/

Delete operation of resource: vrrp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRRP - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/

Retrieve operation of resource: vrrp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "mac-refresh": "integer",          "reload-delay": "integer",
          "min-delay": "integer"
        },
        "interface-name": "string",          "interval": "integer",
          "detection-multiplier": "integer"
        },              {
                "accept-mode-disable": [ null ],
                "follow": "string",                  "auto-configure": "boolean",
                  "ip-address": "string"
                },
                "slave-virtual-router-id": "integer",                    {
                      "ip-address": "string"
                    }
                  ]
                }
              }
            ]
          },                {                    "auto-configure": "boolean",
                    "ip-address": "string"
                  },
                  "bfd": "string",                      {
                        "priority": "integer",
                        "interface-name": "string"
                      }
                    ]
                  },                    "advertisement-time-in-msec": "integer",
                    "forced": [ null ],
                    "advertisement-time-in-sec": "integer"
                  },                      {
                        "ip-address": "string"
                      }
                    ]
                  },
                  "priority": "integer",                      {
                        "object-name": "string",
                        "priority-decrement": "integer"
                      }
                    ]
                  },
                  "accept-mode-disable": [ null ],
                  "session-name": "string",
                  "vr-id": "integer",
                  "preempt": "integer"
                }
              ]
            }
          }
        },              {
                "accept-mode-disable": [ null ],
                "follow": "string",
                "slave-virtual-router-id": "integer",                    {
                      "ip-address": "string"
                    }
                  ]
                },
                "primary-ipv4-address": "string"
              }
            ]
          },                {                      {
                        "object-name": "string",
                        "priority-decrement": "integer"
                      }
                    ]
                  },
                  "session-name": "string",
                  "bfd": "string",                      {
                        "priority": "integer",
                        "interface-name": "string"
                      }
                    ]
                  },                    "advertisement-time-in-msec": "integer",
                    "forced": [ null ],
                    "advertisement-time-in-sec": "integer"
                  },
                  "primary-ipv4-address": "string",
                  "priority": "integer",
                  "preempt": "integer",                      {
                        "ip-address": "string"
                      }
                    ]
                  },
                  "accept-mode-disable": [ null ],
                  "vr-id": "integer",
                  "text-password": "string"
                }
              ]
            }
          }
        }
      }
    ]
  }
}

LOGGING - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/logging/

Update operation of resource: logging

loggingbody object

Request Content-Types: application/json
Request Example
{
  "state-change-disable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/logging/

Create operation of resource: logging

loggingbody object

Request Content-Types: application/json
Request Example
{
  "state-change-disable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/logging/

Delete operation of resource: logging

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/logging/

Retrieve operation of resource: logging

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "state-change-disable": [ null ]
}

INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/

Update operation of resource: interfaces

interfacesbody object

Request Content-Types: application/json
Request Example
{    {
      "mac-refresh": "integer",        "reload-delay": "integer",
        "min-delay": "integer"
      },
      "interface-name": "string",        "interval": "integer",
        "detection-multiplier": "integer"
      },            {
              "accept-mode-disable": [ null ],
              "follow": "string",                "auto-configure": "boolean",
                "ip-address": "string"
              },
              "slave-virtual-router-id": "integer",                  {
                    "ip-address": "string"
                  }
                ]
              }
            }
          ]
        },              {                  "auto-configure": "boolean",
                  "ip-address": "string"
                },
                "bfd": "string",                    {
                      "priority": "integer",
                      "interface-name": "string"
                    }
                  ]
                },                  "advertisement-time-in-msec": "integer",
                  "forced": [ null ],
                  "advertisement-time-in-sec": "integer"
                },                    {
                      "ip-address": "string"
                    }
                  ]
                },
                "priority": "integer",                    {
                      "object-name": "string",
                      "priority-decrement": "integer"
                    }
                  ]
                },
                "accept-mode-disable": [ null ],
                "session-name": "string",
                "vr-id": "integer",
                "preempt": "integer"
              }
            ]
          }
        }
      },            {
              "accept-mode-disable": [ null ],
              "follow": "string",
              "slave-virtual-router-id": "integer",                  {
                    "ip-address": "string"
                  }
                ]
              },
              "primary-ipv4-address": "string"
            }
          ]
        },              {                    {
                      "object-name": "string",
                      "priority-decrement": "integer"
                    }
                  ]
                },
                "session-name": "string",
                "bfd": "string",                    {
                      "priority": "integer",
                      "interface-name": "string"
                    }
                  ]
                },                  "advertisement-time-in-msec": "integer",
                  "forced": [ null ],
                  "advertisement-time-in-sec": "integer"
                },
                "primary-ipv4-address": "string",
                "priority": "integer",
                "preempt": "integer",                    {
                      "ip-address": "string"
                    }
                  ]
                },
                "accept-mode-disable": [ null ],
                "vr-id": "integer",
                "text-password": "string"
              }
            ]
          }
        },      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/

Create operation of resource: interfaces

interfacesbody object

Request Content-Types: application/json
Request Example
{    {
      "mac-refresh": "integer",        "reload-delay": "integer",
        "min-delay": "integer"
      },
      "interface-name": "string",        "interval": "integer",
        "detection-multiplier": "integer"
      },            {
              "accept-mode-disable": [ null ],
              "follow": "string",                "auto-configure": "boolean",
                "ip-address": "string"
              },
              "slave-virtual-router-id": "integer",                  {
                    "ip-address": "string"
                  }
                ]
              }
            }
          ]
        },              {                  "auto-configure": "boolean",
                  "ip-address": "string"
                },
                "bfd": "string",                    {
                      "priority": "integer",
                      "interface-name": "string"
                    }
                  ]
                },                  "advertisement-time-in-msec": "integer",
                  "forced": [ null ],
                  "advertisement-time-in-sec": "integer"
                },                    {
                      "ip-address": "string"
                    }
                  ]
                },
                "priority": "integer",                    {
                      "object-name": "string",
                      "priority-decrement": "integer"
                    }
                  ]
                },
                "accept-mode-disable": [ null ],
                "session-name": "string",
                "vr-id": "integer",
                "preempt": "integer"
              }
            ]
          }
        }
      },            {
              "accept-mode-disable": [ null ],
              "follow": "string",
              "slave-virtual-router-id": "integer",                  {
                    "ip-address": "string"
                  }
                ]
              },
              "primary-ipv4-address": "string"
            }
          ]
        },              {                    {
                      "object-name": "string",
                      "priority-decrement": "integer"
                    }
                  ]
                },
                "session-name": "string",
                "bfd": "string",                    {
                      "priority": "integer",
                      "interface-name": "string"
                    }
                  ]
                },                  "advertisement-time-in-msec": "integer",
                  "forced": [ null ],
                  "advertisement-time-in-sec": "integer"
                },
                "primary-ipv4-address": "string",
                "priority": "integer",
                "preempt": "integer",                    {
                      "ip-address": "string"
                    }
                  ]
                },
                "accept-mode-disable": [ null ],
                "vr-id": "integer",
                "text-password": "string"
              }
            ]
          }
        },      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/

Delete operation of resource: interfaces

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/

Retrieve operation of resource: interfaces

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "mac-refresh": "integer",        "reload-delay": "integer",
        "min-delay": "integer"
      },
      "interface-name": "string",        "interval": "integer",
        "detection-multiplier": "integer"
      },            {
              "accept-mode-disable": [ null ],
              "follow": "string",                "auto-configure": "boolean",
                "ip-address": "string"
              },
              "slave-virtual-router-id": "integer",                  {
                    "ip-address": "string"
                  }
                ]
              }
            }
          ]
        },              {                  "auto-configure": "boolean",
                  "ip-address": "string"
                },
                "bfd": "string",                    {
                      "priority": "integer",
                      "interface-name": "string"
                    }
                  ]
                },                  "advertisement-time-in-msec": "integer",
                  "forced": [ null ],
                  "advertisement-time-in-sec": "integer"
                },                    {
                      "ip-address": "string"
                    }
                  ]
                },
                "priority": "integer",                    {
                      "object-name": "string",
                      "priority-decrement": "integer"
                    }
                  ]
                },
                "accept-mode-disable": [ null ],
                "session-name": "string",
                "vr-id": "integer",
                "preempt": "integer"
              }
            ]
          }
        }
      },            {
              "accept-mode-disable": [ null ],
              "follow": "string",
              "slave-virtual-router-id": "integer",                  {
                    "ip-address": "string"
                  }
                ]
              },
              "primary-ipv4-address": "string"
            }
          ]
        },              {                    {
                      "object-name": "string",
                      "priority-decrement": "integer"
                    }
                  ]
                },
                "session-name": "string",
                "bfd": "string",                    {
                      "priority": "integer",
                      "interface-name": "string"
                    }
                  ]
                },                  "advertisement-time-in-msec": "integer",
                  "forced": [ null ],
                  "advertisement-time-in-sec": "integer"
                },
                "primary-ipv4-address": "string",
                "priority": "integer",
                "preempt": "integer",                    {
                      "ip-address": "string"
                    }
                  ]
                },
                "accept-mode-disable": [ null ],
                "vr-id": "integer",
                "text-password": "string"
              }
            ]
          }
        },      }
    }
  ]
}

INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/

Update operation of resource: interface

interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "mac-refresh": "integer",    "reload-delay": "integer",
    "min-delay": "integer"
  },
  "interface-name": "string",    "interval": "integer",
    "detection-multiplier": "integer"
  },        {
          "accept-mode-disable": [ null ],
          "follow": "string",            "auto-configure": "boolean",
            "ip-address": "string"
          },
          "slave-virtual-router-id": "integer",              {
                "ip-address": "string"
              }
            ]
          }
        }
      ]
    },          {              "auto-configure": "boolean",
              "ip-address": "string"
            },
            "bfd": "string",                {
                  "priority": "integer",
                  "interface-name": "string"
                }
              ]
            },              "advertisement-time-in-msec": "integer",
              "forced": [ null ],
              "advertisement-time-in-sec": "integer"
            },                {
                  "ip-address": "string"
                }
              ]
            },
            "priority": "integer",                {
                  "object-name": "string",
                  "priority-decrement": "integer"
                }
              ]
            },
            "accept-mode-disable": [ null ],
            "session-name": "string",
            "vr-id": "integer",
            "preempt": "integer"
          }
        ]
      }
    }
  },        {
          "accept-mode-disable": [ null ],
          "follow": "string",
          "slave-virtual-router-id": "integer",              {
                "ip-address": "string"
              }
            ]
          },
          "primary-ipv4-address": "string"
        }
      ]
    },          {                {
                  "object-name": "string",
                  "priority-decrement": "integer"
                }
              ]
            },
            "session-name": "string",
            "bfd": "string",                {
                  "priority": "integer",
                  "interface-name": "string"
                }
              ]
            },              "advertisement-time-in-msec": "integer",
              "forced": [ null ],
              "advertisement-time-in-sec": "integer"
            },
            "primary-ipv4-address": "string",
            "priority": "integer",
            "preempt": "integer",                {
                  "ip-address": "string"
                }
              ]
            },
            "accept-mode-disable": [ null ],
            "vr-id": "integer",
            "text-password": "string"
          }
        ]
      }
    },        "virtual-router": [ null ]
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/

Create operation of resource: interface

interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "mac-refresh": "integer",    "reload-delay": "integer",
    "min-delay": "integer"
  },
  "interface-name": "string",    "interval": "integer",
    "detection-multiplier": "integer"
  },        {
          "accept-mode-disable": [ null ],
          "follow": "string",            "auto-configure": "boolean",
            "ip-address": "string"
          },
          "slave-virtual-router-id": "integer",              {
                "ip-address": "string"
              }
            ]
          }
        }
      ]
    },          {              "auto-configure": "boolean",
              "ip-address": "string"
            },
            "bfd": "string",                {
                  "priority": "integer",
                  "interface-name": "string"
                }
              ]
            },              "advertisement-time-in-msec": "integer",
              "forced": [ null ],
              "advertisement-time-in-sec": "integer"
            },                {
                  "ip-address": "string"
                }
              ]
            },
            "priority": "integer",                {
                  "object-name": "string",
                  "priority-decrement": "integer"
                }
              ]
            },
            "accept-mode-disable": [ null ],
            "session-name": "string",
            "vr-id": "integer",
            "preempt": "integer"
          }
        ]
      }
    }
  },        {
          "accept-mode-disable": [ null ],
          "follow": "string",
          "slave-virtual-router-id": "integer",              {
                "ip-address": "string"
              }
            ]
          },
          "primary-ipv4-address": "string"
        }
      ]
    },          {                {
                  "object-name": "string",
                  "priority-decrement": "integer"
                }
              ]
            },
            "session-name": "string",
            "bfd": "string",                {
                  "priority": "integer",
                  "interface-name": "string"
                }
              ]
            },              "advertisement-time-in-msec": "integer",
              "forced": [ null ],
              "advertisement-time-in-sec": "integer"
            },
            "primary-ipv4-address": "string",
            "priority": "integer",
            "preempt": "integer",                {
                  "ip-address": "string"
                }
              ]
            },
            "accept-mode-disable": [ null ],
            "vr-id": "integer",
            "text-password": "string"
          }
        ]
      }
    },        "virtual-router": [ null ]
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/

Delete operation of resource: interface

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "mac-refresh": "integer",    "reload-delay": "integer",
    "min-delay": "integer"
  },
  "interface-name": "string",    "interval": "integer",
    "detection-multiplier": "integer"
  },        {
          "accept-mode-disable": [ null ],
          "follow": "string",            "auto-configure": "boolean",
            "ip-address": "string"
          },
          "slave-virtual-router-id": "integer",              {
                "ip-address": "string"
              }
            ]
          }
        }
      ]
    },          {              "auto-configure": "boolean",
              "ip-address": "string"
            },
            "bfd": "string",                {
                  "priority": "integer",
                  "interface-name": "string"
                }
              ]
            },              "advertisement-time-in-msec": "integer",
              "forced": [ null ],
              "advertisement-time-in-sec": "integer"
            },                {
                  "ip-address": "string"
                }
              ]
            },
            "priority": "integer",                {
                  "object-name": "string",
                  "priority-decrement": "integer"
                }
              ]
            },
            "accept-mode-disable": [ null ],
            "session-name": "string",
            "vr-id": "integer",
            "preempt": "integer"
          }
        ]
      }
    }
  },        {
          "accept-mode-disable": [ null ],
          "follow": "string",
          "slave-virtual-router-id": "integer",              {
                "ip-address": "string"
              }
            ]
          },
          "primary-ipv4-address": "string"
        }
      ]
    },          {                {
                  "object-name": "string",
                  "priority-decrement": "integer"
                }
              ]
            },
            "session-name": "string",
            "bfd": "string",                {
                  "priority": "integer",
                  "interface-name": "string"
                }
              ]
            },              "advertisement-time-in-msec": "integer",
              "forced": [ null ],
              "advertisement-time-in-sec": "integer"
            },
            "primary-ipv4-address": "string",
            "priority": "integer",
            "preempt": "integer",                {
                  "ip-address": "string"
                }
              ]
            },
            "accept-mode-disable": [ null ],
            "vr-id": "integer",
            "text-password": "string"
          }
        ]
      }
    },        "virtual-router": [ null ]
      }
    }
  }
}

IPV6 - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/

Update operation of resource: ipv6

ipv6body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {
        "accept-mode-disable": [ null ],
        "follow": "string",          "auto-configure": "boolean",
          "ip-address": "string"
        },
        "slave-virtual-router-id": "integer",            {
              "ip-address": "string"
            }
          ]
        }
      }
    ]
  },        {            "auto-configure": "boolean",
            "ip-address": "string"
          },
          "bfd": "string",              {
                "priority": "integer",
                "interface-name": "string"
              }
            ]
          },            "advertisement-time-in-msec": "integer",
            "forced": [ null ],
            "advertisement-time-in-sec": "integer"
          },              {
                "ip-address": "string"
              }
            ]
          },
          "priority": "integer",              {
                "object-name": "string",
                "priority-decrement": "integer"
              }
            ]
          },
          "accept-mode-disable": [ null ],
          "session-name": "string",
          "vr-id": "integer",
          "preempt": "integer"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/

Create operation of resource: ipv6

ipv6body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {
        "accept-mode-disable": [ null ],
        "follow": "string",          "auto-configure": "boolean",
          "ip-address": "string"
        },
        "slave-virtual-router-id": "integer",            {
              "ip-address": "string"
            }
          ]
        }
      }
    ]
  },        {            "auto-configure": "boolean",
            "ip-address": "string"
          },
          "bfd": "string",              {
                "priority": "integer",
                "interface-name": "string"
              }
            ]
          },            "advertisement-time-in-msec": "integer",
            "forced": [ null ],
            "advertisement-time-in-sec": "integer"
          },              {
                "ip-address": "string"
              }
            ]
          },
          "priority": "integer",              {
                "object-name": "string",
                "priority-decrement": "integer"
              }
            ]
          },
          "accept-mode-disable": [ null ],
          "session-name": "string",
          "vr-id": "integer",
          "preempt": "integer"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/

Delete operation of resource: ipv6

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/

Retrieve operation of resource: ipv6

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "accept-mode-disable": [ null ],
        "follow": "string",          "auto-configure": "boolean",
          "ip-address": "string"
        },
        "slave-virtual-router-id": "integer",            {
              "ip-address": "string"
            }
          ]
        }
      }
    ]
  },        {            "auto-configure": "boolean",
            "ip-address": "string"
          },
          "bfd": "string",              {
                "priority": "integer",
                "interface-name": "string"
              }
            ]
          },            "advertisement-time-in-msec": "integer",
            "forced": [ null ],
            "advertisement-time-in-sec": "integer"
          },              {
                "ip-address": "string"
              }
            ]
          },
          "priority": "integer",              {
                "object-name": "string",
                "priority-decrement": "integer"
              }
            ]
          },
          "accept-mode-disable": [ null ],
          "session-name": "string",
          "vr-id": "integer",
          "preempt": "integer"
        }
      ]
    }
  }
}

VERSION3 - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/

Update operation of resource: version3

version3body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {
        "session-name": "string",
        "bfd": "string",            {
              "priority": "integer",
              "interface-name": "string"
            }
          ]
        },
        "primary-ipv4-address": "string",          "advertisement-time-in-msec": "integer",
          "forced": [ null ],
          "advertisement-time-in-sec": "integer"
        },
        "priority": "integer",            {
              "object-name": "string",
              "priority-decrement": "integer"
            }
          ]
        },            {
              "ip-address": "string"
            }
          ]
        },
        "accept-mode-disable": [ null ],
        "vr-id": "integer",
        "preempt": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION3 - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/

Create operation of resource: version3

version3body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {
        "session-name": "string",
        "bfd": "string",            {
              "priority": "integer",
              "interface-name": "string"
            }
          ]
        },
        "primary-ipv4-address": "string",          "advertisement-time-in-msec": "integer",
          "forced": [ null ],
          "advertisement-time-in-sec": "integer"
        },
        "priority": "integer",            {
              "object-name": "string",
              "priority-decrement": "integer"
            }
          ]
        },            {
              "ip-address": "string"
            }
          ]
        },
        "accept-mode-disable": [ null ],
        "vr-id": "integer",
        "preempt": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION3 - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/

Delete operation of resource: version3

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION3 - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/

Retrieve operation of resource: version3

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "session-name": "string",
        "bfd": "string",            {
              "priority": "integer",
              "interface-name": "string"
            }
          ]
        },
        "primary-ipv4-address": "string",          "advertisement-time-in-msec": "integer",
          "forced": [ null ],
          "advertisement-time-in-sec": "integer"
        },
        "priority": "integer",            {
              "object-name": "string",
              "priority-decrement": "integer"
            }
          ]
        },            {
              "ip-address": "string"
            }
          ]
        },
        "accept-mode-disable": [ null ],
        "vr-id": "integer",
        "preempt": "integer"
      }
    ]
  }
}

VIRTUAL-ROUTERS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/

Update operation of resource: virtual-routers

virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {          {
            "object-name": "string",
            "priority-decrement": "integer"
          }
        ]
      },
      "session-name": "string",
      "bfd": "string",          {
            "priority": "integer",
            "interface-name": "string"
          }
        ]
      },        "advertisement-time-in-msec": "integer",
        "forced": [ null ],
        "advertisement-time-in-sec": "integer"
      },
      "primary-ipv4-address": "string",
      "priority": "integer",
      "preempt": "integer",          {
            "ip-address": "string"
          }
        ]
      },
      "accept-mode-disable": [ null ],
      "vr-id": "integer",
      "text-password": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/

Create operation of resource: virtual-routers

virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {          {
            "object-name": "string",
            "priority-decrement": "integer"
          }
        ]
      },
      "session-name": "string",
      "bfd": "string",          {
            "priority": "integer",
            "interface-name": "string"
          }
        ]
      },        "advertisement-time-in-msec": "integer",
        "forced": [ null ],
        "advertisement-time-in-sec": "integer"
      },
      "primary-ipv4-address": "string",
      "priority": "integer",
      "preempt": "integer",          {
            "ip-address": "string"
          }
        ]
      },
      "accept-mode-disable": [ null ],
      "vr-id": "integer",
      "text-password": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/

Delete operation of resource: virtual-routers

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/

Retrieve operation of resource: virtual-routers

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {
            "object-name": "string",
            "priority-decrement": "integer"
          }
        ]
      },
      "session-name": "string",
      "bfd": "string",          {
            "priority": "integer",
            "interface-name": "string"
          }
        ]
      },        "advertisement-time-in-msec": "integer",
        "forced": [ null ],
        "advertisement-time-in-sec": "integer"
      },
      "primary-ipv4-address": "string",
      "priority": "integer",
      "preempt": "integer",          {
            "ip-address": "string"
          }
        ]
      },
      "accept-mode-disable": [ null ],
      "vr-id": "integer",
      "text-password": "string"
    }
  ]
}

VIRTUAL-ROUTER - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/

Update operation of resource: virtual-router

virtual-routerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        "object-name": "string",
        "priority-decrement": "integer"
      }
    ]
  },
  "session-name": "string",
  "bfd": "string",      {
        "priority": "integer",
        "interface-name": "string"
      }
    ]
  },    "advertisement-time-in-msec": "integer",
    "forced": [ null ],
    "advertisement-time-in-sec": "integer"
  },
  "primary-ipv4-address": "string",
  "priority": "integer",
  "preempt": "integer",      {
        "ip-address": "string"
      }
    ]
  },
  "accept-mode-disable": [ null ],
  "vr-id": "integer",
  "text-password": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/

Create operation of resource: virtual-router

virtual-routerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        "object-name": "string",
        "priority-decrement": "integer"
      }
    ]
  },
  "session-name": "string",
  "bfd": "string",      {
        "priority": "integer",
        "interface-name": "string"
      }
    ]
  },    "advertisement-time-in-msec": "integer",
    "forced": [ null ],
    "advertisement-time-in-sec": "integer"
  },
  "primary-ipv4-address": "string",
  "priority": "integer",
  "preempt": "integer",      {
        "ip-address": "string"
      }
    ]
  },
  "accept-mode-disable": [ null ],
  "vr-id": "integer",
  "text-password": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/

Delete operation of resource: virtual-router

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/

Retrieve operation of resource: virtual-router

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "object-name": "string",
        "priority-decrement": "integer"
      }
    ]
  },
  "session-name": "string",
  "bfd": "string",      {
        "priority": "integer",
        "interface-name": "string"
      }
    ]
  },    "advertisement-time-in-msec": "integer",
    "forced": [ null ],
    "advertisement-time-in-sec": "integer"
  },
  "primary-ipv4-address": "string",
  "priority": "integer",
  "preempt": "integer",      {
        "ip-address": "string"
      }
    ]
  },
  "accept-mode-disable": [ null ],
  "vr-id": "integer",
  "text-password": "string"
}

GLOBAL-IPV6-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/global-ipv6-addresses/

Update operation of resource: global-ipv6-addresses

global-ipv6-addressesbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/global-ipv6-addresses/

Create operation of resource: global-ipv6-addresses

global-ipv6-addressesbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/global-ipv6-addresses/

Delete operation of resource: global-ipv6-addresses

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/global-ipv6-addresses/

Retrieve operation of resource: global-ipv6-addresses

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "ip-address": "string"
    }
  ]
}

GLOBAL-IPV6-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/global-ipv6-addresses/global-ipv6-address/{ip-address}/

Update operation of resource: global-ipv6-address

global-ipv6-addressbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/global-ipv6-addresses/global-ipv6-address/{ip-address}/

Create operation of resource: global-ipv6-address

global-ipv6-addressbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/global-ipv6-addresses/global-ipv6-address/{ip-address}/

Delete operation of resource: global-ipv6-address

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/global-ipv6-addresses/global-ipv6-address/{ip-address}/

Retrieve operation of resource: global-ipv6-address

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "ip-address": "string"
}

TRACKS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracks/

Update operation of resource: tracks

tracksbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "priority": "integer",
      "interface-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracks/

Create operation of resource: tracks

tracksbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "priority": "integer",
      "interface-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracks/

Delete operation of resource: tracks

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracks/

Retrieve operation of resource: tracks

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "priority": "integer",
      "interface-name": "string"
    }
  ]
}

TRACK - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Update operation of resource: track

trackbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "priority": "integer",
  "interface-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Create operation of resource: track

trackbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "priority": "integer",
  "interface-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Delete operation of resource: track

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Retrieve operation of resource: track

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "priority": "integer",
  "interface-name": "string"
}

TIMER - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/timer/

Update operation of resource: timer

timerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{
  "advertisement-time-in-msec": "integer",
  "forced": [ null ],
  "advertisement-time-in-sec": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/timer/

Create operation of resource: timer

timerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{
  "advertisement-time-in-msec": "integer",
  "forced": [ null ],
  "advertisement-time-in-sec": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/timer/

Delete operation of resource: timer

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/timer/

Retrieve operation of resource: timer

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "advertisement-time-in-msec": "integer",
  "forced": [ null ],
  "advertisement-time-in-sec": "integer"
}

TRACKED-OBJECTS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Update operation of resource: tracked-objects

tracked-objectsbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "object-name": "string",
      "priority-decrement": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Create operation of resource: tracked-objects

tracked-objectsbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "object-name": "string",
      "priority-decrement": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Delete operation of resource: tracked-objects

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Retrieve operation of resource: tracked-objects

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "object-name": "string",
      "priority-decrement": "integer"
    }
  ]
}

TRACKED-OBJECT - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Update operation of resource: tracked-object

tracked-objectbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Request Content-Types: application/json
Request Example
{
  "object-name": "string",
  "priority-decrement": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Create operation of resource: tracked-object

tracked-objectbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Request Content-Types: application/json
Request Example
{
  "object-name": "string",
  "priority-decrement": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Delete operation of resource: tracked-object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Retrieve operation of resource: tracked-object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "object-name": "string",
  "priority-decrement": "integer"
}

LINK-LOCAL-IPV6-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/link-local-ipv6-address/

Create operation of resource: link-local-ipv6-address

link-local-ipv6-addressbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{
  "auto-configure": "boolean",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTERS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/

Update operation of resource: slave-virtual-routers

slave-virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {
      "accept-mode-disable": [ null ],
      "follow": "string",
      "slave-virtual-router-id": "integer",          {
            "ip-address": "string"
          }
        ]
      },
      "primary-ipv4-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTERS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/

Create operation of resource: slave-virtual-routers

slave-virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {
      "accept-mode-disable": [ null ],
      "follow": "string",
      "slave-virtual-router-id": "integer",          {
            "ip-address": "string"
          }
        ]
      },
      "primary-ipv4-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTERS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/

Delete operation of resource: slave-virtual-routers

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTERS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/

Retrieve operation of resource: slave-virtual-routers

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "accept-mode-disable": [ null ],
      "follow": "string",
      "slave-virtual-router-id": "integer",          {
            "ip-address": "string"
          }
        ]
      },
      "primary-ipv4-address": "string"
    }
  ]
}

SLAVE-VIRTUAL-ROUTER - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/

Update operation of resource: slave-virtual-router

slave-virtual-routerbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{
  "accept-mode-disable": [ null ],
  "follow": "string",
  "slave-virtual-router-id": "integer",      {
        "ip-address": "string"
      }
    ]
  },
  "primary-ipv4-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTER - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/

Create operation of resource: slave-virtual-router

slave-virtual-routerbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{
  "accept-mode-disable": [ null ],
  "follow": "string",
  "slave-virtual-router-id": "integer",      {
        "ip-address": "string"
      }
    ]
  },
  "primary-ipv4-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTER - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/

Delete operation of resource: slave-virtual-router

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTER - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/

Retrieve operation of resource: slave-virtual-router

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "accept-mode-disable": [ null ],
  "follow": "string",
  "slave-virtual-router-id": "integer",      {
        "ip-address": "string"
      }
    ]
  },
  "primary-ipv4-address": "string"
}

LINK-LOCAL-IPV6-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/link-local-ipv6-address/

Create operation of resource: link-local-ipv6-address

link-local-ipv6-addressbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{
  "auto-configure": "boolean",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/global-ipv6-addresses/

Update operation of resource: global-ipv6-addresses

global-ipv6-addressesbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/global-ipv6-addresses/

Create operation of resource: global-ipv6-addresses

global-ipv6-addressesbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/global-ipv6-addresses/

Delete operation of resource: global-ipv6-addresses

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/global-ipv6-addresses/

Retrieve operation of resource: global-ipv6-addresses

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "ip-address": "string"
    }
  ]
}

GLOBAL-IPV6-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/global-ipv6-addresses/global-ipv6-address/{ip-address}/

Update operation of resource: global-ipv6-address

global-ipv6-addressbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/global-ipv6-addresses/global-ipv6-address/{ip-address}/

Create operation of resource: global-ipv6-address

global-ipv6-addressbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/global-ipv6-addresses/global-ipv6-address/{ip-address}/

Delete operation of resource: global-ipv6-address

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/global-ipv6-addresses/global-ipv6-address/{ip-address}/

Retrieve operation of resource: global-ipv6-address

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "ip-address": "string"
}

DELAY - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/delay/

Update operation of resource: delay

delaybody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "reload-delay": "integer",
  "min-delay": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DELAY - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/delay/

Create operation of resource: delay

delaybody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "reload-delay": "integer",
  "min-delay": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DELAY - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/delay/

Delete operation of resource: delay

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DELAY - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/delay/

Retrieve operation of resource: delay

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "reload-delay": "integer",
  "min-delay": "integer"
}

IPV4 - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/

Update operation of resource: ipv4

ipv4body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {
        "accept-mode-disable": [ null ],
        "follow": "string",
        "slave-virtual-router-id": "integer",            {
              "ip-address": "string"
            }
          ]
        },
        "primary-ipv4-address": "string"
      }
    ]
  },        {              {
                "object-name": "string",
                "priority-decrement": "integer"
              }
            ]
          },
          "session-name": "string",
          "bfd": "string",              {
                "priority": "integer",
                "interface-name": "string"
              }
            ]
          },            "advertisement-time-in-msec": "integer",
            "forced": [ null ],
            "advertisement-time-in-sec": "integer"
          },
          "primary-ipv4-address": "string",
          "priority": "integer",
          "preempt": "integer",              {
                "ip-address": "string"
              }
            ]
          },
          "accept-mode-disable": [ null ],
          "vr-id": "integer",
          "text-password": "string"
        }
      ]
    }
  },        {
          "session-name": "string",
          "bfd": "string",              {
                "priority": "integer",
                "interface-name": "string"
              }
            ]
          },
          "primary-ipv4-address": "string",            "advertisement-time-in-msec": "integer",
            "forced": [ null ],
            "advertisement-time-in-sec": "integer"
          },
          "priority": "integer",              {
                "object-name": "string",
                "priority-decrement": "integer"
              }
            ]
          },              {
                "ip-address": "string"
              }
            ]
          },
          "accept-mode-disable": [ null ],
          "vr-id": "integer",
          "preempt": "integer"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/

Create operation of resource: ipv4

ipv4body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {
        "accept-mode-disable": [ null ],
        "follow": "string",
        "slave-virtual-router-id": "integer",            {
              "ip-address": "string"
            }
          ]
        },
        "primary-ipv4-address": "string"
      }
    ]
  },        {              {
                "object-name": "string",
                "priority-decrement": "integer"
              }
            ]
          },
          "session-name": "string",
          "bfd": "string",              {
                "priority": "integer",
                "interface-name": "string"
              }
            ]
          },            "advertisement-time-in-msec": "integer",
            "forced": [ null ],
            "advertisement-time-in-sec": "integer"
          },
          "primary-ipv4-address": "string",
          "priority": "integer",
          "preempt": "integer",              {
                "ip-address": "string"
              }
            ]
          },
          "accept-mode-disable": [ null ],
          "vr-id": "integer",
          "text-password": "string"
        }
      ]
    }
  },        {
          "session-name": "string",
          "bfd": "string",              {
                "priority": "integer",
                "interface-name": "string"
              }
            ]
          },
          "primary-ipv4-address": "string",            "advertisement-time-in-msec": "integer",
            "forced": [ null ],
            "advertisement-time-in-sec": "integer"
          },
          "priority": "integer",              {
                "object-name": "string",
                "priority-decrement": "integer"
              }
            ]
          },              {
                "ip-address": "string"
              }
            ]
          },
          "accept-mode-disable": [ null ],
          "vr-id": "integer",
          "preempt": "integer"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/

Delete operation of resource: ipv4

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/

Retrieve operation of resource: ipv4

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "accept-mode-disable": [ null ],
        "follow": "string",
        "slave-virtual-router-id": "integer",            {
              "ip-address": "string"
            }
          ]
        },
        "primary-ipv4-address": "string"
      }
    ]
  },        {              {
                "object-name": "string",
                "priority-decrement": "integer"
              }
            ]
          },
          "session-name": "string",
          "bfd": "string",              {
                "priority": "integer",
                "interface-name": "string"
              }
            ]
          },            "advertisement-time-in-msec": "integer",
            "forced": [ null ],
            "advertisement-time-in-sec": "integer"
          },
          "primary-ipv4-address": "string",
          "priority": "integer",
          "preempt": "integer",              {
                "ip-address": "string"
              }
            ]
          },
          "accept-mode-disable": [ null ],
          "vr-id": "integer",
          "text-password": "string"
        }
      ]
    }
  },        {
          "session-name": "string",
          "bfd": "string",              {
                "priority": "integer",
                "interface-name": "string"
              }
            ]
          },
          "primary-ipv4-address": "string",            "advertisement-time-in-msec": "integer",
            "forced": [ null ],
            "advertisement-time-in-sec": "integer"
          },
          "priority": "integer",              {
                "object-name": "string",
                "priority-decrement": "integer"
              }
            ]
          },              {
                "ip-address": "string"
              }
            ]
          },
          "accept-mode-disable": [ null ],
          "vr-id": "integer",
          "preempt": "integer"
        }
      ]
    }
  }
}

VERSION3 - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/

Update operation of resource: version3

version3body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {
        "session-name": "string",
        "bfd": "string",            {
              "priority": "integer",
              "interface-name": "string"
            }
          ]
        },
        "primary-ipv4-address": "string",          "advertisement-time-in-msec": "integer",
          "forced": [ null ],
          "advertisement-time-in-sec": "integer"
        },
        "priority": "integer",            {
              "object-name": "string",
              "priority-decrement": "integer"
            }
          ]
        },            {
              "ip-address": "string"
            }
          ]
        },
        "accept-mode-disable": [ null ],
        "vr-id": "integer",
        "preempt": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION3 - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/

Create operation of resource: version3

version3body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {
        "session-name": "string",
        "bfd": "string",            {
              "priority": "integer",
              "interface-name": "string"
            }
          ]
        },
        "primary-ipv4-address": "string",          "advertisement-time-in-msec": "integer",
          "forced": [ null ],
          "advertisement-time-in-sec": "integer"
        },
        "priority": "integer",            {
              "object-name": "string",
              "priority-decrement": "integer"
            }
          ]
        },            {
              "ip-address": "string"
            }
          ]
        },
        "accept-mode-disable": [ null ],
        "vr-id": "integer",
        "preempt": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION3 - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/

Delete operation of resource: version3

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION3 - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/

Retrieve operation of resource: version3

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "session-name": "string",
        "bfd": "string",            {
              "priority": "integer",
              "interface-name": "string"
            }
          ]
        },
        "primary-ipv4-address": "string",          "advertisement-time-in-msec": "integer",
          "forced": [ null ],
          "advertisement-time-in-sec": "integer"
        },
        "priority": "integer",            {
              "object-name": "string",
              "priority-decrement": "integer"
            }
          ]
        },            {
              "ip-address": "string"
            }
          ]
        },
        "accept-mode-disable": [ null ],
        "vr-id": "integer",
        "preempt": "integer"
      }
    ]
  }
}

VIRTUAL-ROUTERS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/

Update operation of resource: virtual-routers

virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {          {
            "object-name": "string",
            "priority-decrement": "integer"
          }
        ]
      },
      "session-name": "string",
      "bfd": "string",          {
            "priority": "integer",
            "interface-name": "string"
          }
        ]
      },        "advertisement-time-in-msec": "integer",
        "forced": [ null ],
        "advertisement-time-in-sec": "integer"
      },
      "primary-ipv4-address": "string",
      "priority": "integer",
      "preempt": "integer",          {
            "ip-address": "string"
          }
        ]
      },
      "accept-mode-disable": [ null ],
      "vr-id": "integer",
      "text-password": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/

Create operation of resource: virtual-routers

virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {          {
            "object-name": "string",
            "priority-decrement": "integer"
          }
        ]
      },
      "session-name": "string",
      "bfd": "string",          {
            "priority": "integer",
            "interface-name": "string"
          }
        ]
      },        "advertisement-time-in-msec": "integer",
        "forced": [ null ],
        "advertisement-time-in-sec": "integer"
      },
      "primary-ipv4-address": "string",
      "priority": "integer",
      "preempt": "integer",          {
            "ip-address": "string"
          }
        ]
      },
      "accept-mode-disable": [ null ],
      "vr-id": "integer",
      "text-password": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/

Delete operation of resource: virtual-routers

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/

Retrieve operation of resource: virtual-routers

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {
            "object-name": "string",
            "priority-decrement": "integer"
          }
        ]
      },
      "session-name": "string",
      "bfd": "string",          {
            "priority": "integer",
            "interface-name": "string"
          }
        ]
      },        "advertisement-time-in-msec": "integer",
        "forced": [ null ],
        "advertisement-time-in-sec": "integer"
      },
      "primary-ipv4-address": "string",
      "priority": "integer",
      "preempt": "integer",          {
            "ip-address": "string"
          }
        ]
      },
      "accept-mode-disable": [ null ],
      "vr-id": "integer",
      "text-password": "string"
    }
  ]
}

VIRTUAL-ROUTER - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/

Update operation of resource: virtual-router

virtual-routerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        "object-name": "string",
        "priority-decrement": "integer"
      }
    ]
  },
  "session-name": "string",
  "bfd": "string",      {
        "priority": "integer",
        "interface-name": "string"
      }
    ]
  },    "advertisement-time-in-msec": "integer",
    "forced": [ null ],
    "advertisement-time-in-sec": "integer"
  },
  "primary-ipv4-address": "string",
  "priority": "integer",
  "preempt": "integer",      {
        "ip-address": "string"
      }
    ]
  },
  "accept-mode-disable": [ null ],
  "vr-id": "integer",
  "text-password": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/

Create operation of resource: virtual-router

virtual-routerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        "object-name": "string",
        "priority-decrement": "integer"
      }
    ]
  },
  "session-name": "string",
  "bfd": "string",      {
        "priority": "integer",
        "interface-name": "string"
      }
    ]
  },    "advertisement-time-in-msec": "integer",
    "forced": [ null ],
    "advertisement-time-in-sec": "integer"
  },
  "primary-ipv4-address": "string",
  "priority": "integer",
  "preempt": "integer",      {
        "ip-address": "string"
      }
    ]
  },
  "accept-mode-disable": [ null ],
  "vr-id": "integer",
  "text-password": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/

Delete operation of resource: virtual-router

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/

Retrieve operation of resource: virtual-router

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "object-name": "string",
        "priority-decrement": "integer"
      }
    ]
  },
  "session-name": "string",
  "bfd": "string",      {
        "priority": "integer",
        "interface-name": "string"
      }
    ]
  },    "advertisement-time-in-msec": "integer",
    "forced": [ null ],
    "advertisement-time-in-sec": "integer"
  },
  "primary-ipv4-address": "string",
  "priority": "integer",
  "preempt": "integer",      {
        "ip-address": "string"
      }
    ]
  },
  "accept-mode-disable": [ null ],
  "vr-id": "integer",
  "text-password": "string"
}

TIMER - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/timer/

Update operation of resource: timer

timerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{
  "advertisement-time-in-msec": "integer",
  "forced": [ null ],
  "advertisement-time-in-sec": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/timer/

Create operation of resource: timer

timerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{
  "advertisement-time-in-msec": "integer",
  "forced": [ null ],
  "advertisement-time-in-sec": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/timer/

Delete operation of resource: timer

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/timer/

Retrieve operation of resource: timer

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "advertisement-time-in-msec": "integer",
  "forced": [ null ],
  "advertisement-time-in-sec": "integer"
}

SECONDARY-IPV4-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/

Update operation of resource: secondary-ipv4-addresses

secondary-ipv4-addressesbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/

Create operation of resource: secondary-ipv4-addresses

secondary-ipv4-addressesbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/

Delete operation of resource: secondary-ipv4-addresses

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/

Retrieve operation of resource: secondary-ipv4-addresses

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "ip-address": "string"
    }
  ]
}

SECONDARY-IPV4-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Update operation of resource: secondary-ipv4-address

secondary-ipv4-addressbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Create operation of resource: secondary-ipv4-address

secondary-ipv4-addressbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Delete operation of resource: secondary-ipv4-address

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Retrieve operation of resource: secondary-ipv4-address

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "ip-address": "string"
}

TRACKED-OBJECTS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Update operation of resource: tracked-objects

tracked-objectsbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "object-name": "string",
      "priority-decrement": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Create operation of resource: tracked-objects

tracked-objectsbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "object-name": "string",
      "priority-decrement": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Delete operation of resource: tracked-objects

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Retrieve operation of resource: tracked-objects

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "object-name": "string",
      "priority-decrement": "integer"
    }
  ]
}

TRACKED-OBJECT - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Update operation of resource: tracked-object

tracked-objectbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Request Content-Types: application/json
Request Example
{
  "object-name": "string",
  "priority-decrement": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Create operation of resource: tracked-object

tracked-objectbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Request Content-Types: application/json
Request Example
{
  "object-name": "string",
  "priority-decrement": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Delete operation of resource: tracked-object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Retrieve operation of resource: tracked-object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "object-name": "string",
  "priority-decrement": "integer"
}

TRACKS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracks/

Update operation of resource: tracks

tracksbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "priority": "integer",
      "interface-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracks/

Create operation of resource: tracks

tracksbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "priority": "integer",
      "interface-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracks/

Delete operation of resource: tracks

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracks/

Retrieve operation of resource: tracks

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "priority": "integer",
      "interface-name": "string"
    }
  ]
}

TRACK - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Update operation of resource: track

trackbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "priority": "integer",
  "interface-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Create operation of resource: track

trackbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "priority": "integer",
  "interface-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Delete operation of resource: track

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Retrieve operation of resource: track

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "priority": "integer",
  "interface-name": "string"
}

SLAVE-VIRTUAL-ROUTERS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/

Update operation of resource: slave-virtual-routers

slave-virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {
      "accept-mode-disable": [ null ],
      "follow": "string",
      "slave-virtual-router-id": "integer",          {
            "ip-address": "string"
          }
        ]
      },
      "primary-ipv4-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTERS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/

Create operation of resource: slave-virtual-routers

slave-virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {
      "accept-mode-disable": [ null ],
      "follow": "string",
      "slave-virtual-router-id": "integer",          {
            "ip-address": "string"
          }
        ]
      },
      "primary-ipv4-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTERS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/

Delete operation of resource: slave-virtual-routers

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTERS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/

Retrieve operation of resource: slave-virtual-routers

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "accept-mode-disable": [ null ],
      "follow": "string",
      "slave-virtual-router-id": "integer",          {
            "ip-address": "string"
          }
        ]
      },
      "primary-ipv4-address": "string"
    }
  ]
}

SLAVE-VIRTUAL-ROUTER - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/

Update operation of resource: slave-virtual-router

slave-virtual-routerbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{
  "accept-mode-disable": [ null ],
  "follow": "string",
  "slave-virtual-router-id": "integer",      {
        "ip-address": "string"
      }
    ]
  },
  "primary-ipv4-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTER - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/

Create operation of resource: slave-virtual-router

slave-virtual-routerbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{
  "accept-mode-disable": [ null ],
  "follow": "string",
  "slave-virtual-router-id": "integer",      {
        "ip-address": "string"
      }
    ]
  },
  "primary-ipv4-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTER - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/

Delete operation of resource: slave-virtual-router

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTER - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/

Retrieve operation of resource: slave-virtual-router

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "accept-mode-disable": [ null ],
  "follow": "string",
  "slave-virtual-router-id": "integer",      {
        "ip-address": "string"
      }
    ]
  },
  "primary-ipv4-address": "string"
}

SECONDARY-IPV4-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/secondary-ipv4-addresses/

Update operation of resource: secondary-ipv4-addresses

secondary-ipv4-addressesbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/secondary-ipv4-addresses/

Create operation of resource: secondary-ipv4-addresses

secondary-ipv4-addressesbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/secondary-ipv4-addresses/

Delete operation of resource: secondary-ipv4-addresses

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/secondary-ipv4-addresses/

Retrieve operation of resource: secondary-ipv4-addresses

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "ip-address": "string"
    }
  ]
}

SECONDARY-IPV4-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Update operation of resource: secondary-ipv4-address

secondary-ipv4-addressbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Create operation of resource: secondary-ipv4-address

secondary-ipv4-addressbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Delete operation of resource: secondary-ipv4-address

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Retrieve operation of resource: secondary-ipv4-address

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "ip-address": "string"
}

VERSION2 - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/

Update operation of resource: version2

version2body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {            {
              "object-name": "string",
              "priority-decrement": "integer"
            }
          ]
        },
        "session-name": "string",
        "bfd": "string",            {
              "priority": "integer",
              "interface-name": "string"
            }
          ]
        },          "advertisement-time-in-msec": "integer",
          "forced": [ null ],
          "advertisement-time-in-sec": "integer"
        },
        "primary-ipv4-address": "string",
        "priority": "integer",
        "preempt": "integer",            {
              "ip-address": "string"
            }
          ]
        },
        "accept-mode-disable": [ null ],
        "vr-id": "integer",
        "text-password": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION2 - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/

Create operation of resource: version2

version2body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {            {
              "object-name": "string",
              "priority-decrement": "integer"
            }
          ]
        },
        "session-name": "string",
        "bfd": "string",            {
              "priority": "integer",
              "interface-name": "string"
            }
          ]
        },          "advertisement-time-in-msec": "integer",
          "forced": [ null ],
          "advertisement-time-in-sec": "integer"
        },
        "primary-ipv4-address": "string",
        "priority": "integer",
        "preempt": "integer",            {
              "ip-address": "string"
            }
          ]
        },
        "accept-mode-disable": [ null ],
        "vr-id": "integer",
        "text-password": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION2 - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/

Delete operation of resource: version2

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION2 - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/

Retrieve operation of resource: version2

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {            {
              "object-name": "string",
              "priority-decrement": "integer"
            }
          ]
        },
        "session-name": "string",
        "bfd": "string",            {
              "priority": "integer",
              "interface-name": "string"
            }
          ]
        },          "advertisement-time-in-msec": "integer",
          "forced": [ null ],
          "advertisement-time-in-sec": "integer"
        },
        "primary-ipv4-address": "string",
        "priority": "integer",
        "preempt": "integer",            {
              "ip-address": "string"
            }
          ]
        },
        "accept-mode-disable": [ null ],
        "vr-id": "integer",
        "text-password": "string"
      }
    ]
  }
}

VIRTUAL-ROUTERS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/

Update operation of resource: virtual-routers

virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {          {
            "object-name": "string",
            "priority-decrement": "integer"
          }
        ]
      },
      "session-name": "string",
      "bfd": "string",          {
            "priority": "integer",
            "interface-name": "string"
          }
        ]
      },        "advertisement-time-in-msec": "integer",
        "forced": [ null ],
        "advertisement-time-in-sec": "integer"
      },
      "primary-ipv4-address": "string",
      "priority": "integer",
      "preempt": "integer",          {
            "ip-address": "string"
          }
        ]
      },
      "accept-mode-disable": [ null ],
      "vr-id": "integer",
      "text-password": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/

Create operation of resource: virtual-routers

virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {          {
            "object-name": "string",
            "priority-decrement": "integer"
          }
        ]
      },
      "session-name": "string",
      "bfd": "string",          {
            "priority": "integer",
            "interface-name": "string"
          }
        ]
      },        "advertisement-time-in-msec": "integer",
        "forced": [ null ],
        "advertisement-time-in-sec": "integer"
      },
      "primary-ipv4-address": "string",
      "priority": "integer",
      "preempt": "integer",          {
            "ip-address": "string"
          }
        ]
      },
      "accept-mode-disable": [ null ],
      "vr-id": "integer",
      "text-password": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/

Delete operation of resource: virtual-routers

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/

Retrieve operation of resource: virtual-routers

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {
            "object-name": "string",
            "priority-decrement": "integer"
          }
        ]
      },
      "session-name": "string",
      "bfd": "string",          {
            "priority": "integer",
            "interface-name": "string"
          }
        ]
      },        "advertisement-time-in-msec": "integer",
        "forced": [ null ],
        "advertisement-time-in-sec": "integer"
      },
      "primary-ipv4-address": "string",
      "priority": "integer",
      "preempt": "integer",          {
            "ip-address": "string"
          }
        ]
      },
      "accept-mode-disable": [ null ],
      "vr-id": "integer",
      "text-password": "string"
    }
  ]
}

VIRTUAL-ROUTER - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/

Update operation of resource: virtual-router

virtual-routerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        "object-name": "string",
        "priority-decrement": "integer"
      }
    ]
  },
  "session-name": "string",
  "bfd": "string",      {
        "priority": "integer",
        "interface-name": "string"
      }
    ]
  },    "advertisement-time-in-msec": "integer",
    "forced": [ null ],
    "advertisement-time-in-sec": "integer"
  },
  "primary-ipv4-address": "string",
  "priority": "integer",
  "preempt": "integer",      {
        "ip-address": "string"
      }
    ]
  },
  "accept-mode-disable": [ null ],
  "vr-id": "integer",
  "text-password": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/

Create operation of resource: virtual-router

virtual-routerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        "object-name": "string",
        "priority-decrement": "integer"
      }
    ]
  },
  "session-name": "string",
  "bfd": "string",      {
        "priority": "integer",
        "interface-name": "string"
      }
    ]
  },    "advertisement-time-in-msec": "integer",
    "forced": [ null ],
    "advertisement-time-in-sec": "integer"
  },
  "primary-ipv4-address": "string",
  "priority": "integer",
  "preempt": "integer",      {
        "ip-address": "string"
      }
    ]
  },
  "accept-mode-disable": [ null ],
  "vr-id": "integer",
  "text-password": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/

Delete operation of resource: virtual-router

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/

Retrieve operation of resource: virtual-router

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "object-name": "string",
        "priority-decrement": "integer"
      }
    ]
  },
  "session-name": "string",
  "bfd": "string",      {
        "priority": "integer",
        "interface-name": "string"
      }
    ]
  },    "advertisement-time-in-msec": "integer",
    "forced": [ null ],
    "advertisement-time-in-sec": "integer"
  },
  "primary-ipv4-address": "string",
  "priority": "integer",
  "preempt": "integer",      {
        "ip-address": "string"
      }
    ]
  },
  "accept-mode-disable": [ null ],
  "vr-id": "integer",
  "text-password": "string"
}

TIMER - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/timer/

Update operation of resource: timer

timerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{
  "advertisement-time-in-msec": "integer",
  "forced": [ null ],
  "advertisement-time-in-sec": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/timer/

Create operation of resource: timer

timerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{
  "advertisement-time-in-msec": "integer",
  "forced": [ null ],
  "advertisement-time-in-sec": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/timer/

Delete operation of resource: timer

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/timer/

Retrieve operation of resource: timer

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "advertisement-time-in-msec": "integer",
  "forced": [ null ],
  "advertisement-time-in-sec": "integer"
}

SECONDARY-IPV4-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/

Update operation of resource: secondary-ipv4-addresses

secondary-ipv4-addressesbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/

Create operation of resource: secondary-ipv4-addresses

secondary-ipv4-addressesbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/

Delete operation of resource: secondary-ipv4-addresses

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/

Retrieve operation of resource: secondary-ipv4-addresses

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "ip-address": "string"
    }
  ]
}

SECONDARY-IPV4-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Update operation of resource: secondary-ipv4-address

secondary-ipv4-addressbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Create operation of resource: secondary-ipv4-address

secondary-ipv4-addressbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Delete operation of resource: secondary-ipv4-address

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Retrieve operation of resource: secondary-ipv4-address

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "ip-address": "string"
}

TRACKS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracks/

Update operation of resource: tracks

tracksbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "priority": "integer",
      "interface-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracks/

Create operation of resource: tracks

tracksbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "priority": "integer",
      "interface-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracks/

Delete operation of resource: tracks

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracks/

Retrieve operation of resource: tracks

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "priority": "integer",
      "interface-name": "string"
    }
  ]
}

TRACK - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Update operation of resource: track

trackbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "priority": "integer",
  "interface-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Create operation of resource: track

trackbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "priority": "integer",
  "interface-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Delete operation of resource: track

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Retrieve operation of resource: track

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "priority": "integer",
  "interface-name": "string"
}

TRACKED-OBJECTS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Update operation of resource: tracked-objects

tracked-objectsbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "object-name": "string",
      "priority-decrement": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Create operation of resource: tracked-objects

tracked-objectsbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {
      "object-name": "string",
      "priority-decrement": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Delete operation of resource: tracked-objects

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Retrieve operation of resource: tracked-objects

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "object-name": "string",
      "priority-decrement": "integer"
    }
  ]
}

TRACKED-OBJECT - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Update operation of resource: tracked-object

tracked-objectbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Request Content-Types: application/json
Request Example
{
  "object-name": "string",
  "priority-decrement": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Create operation of resource: tracked-object

tracked-objectbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Request Content-Types: application/json
Request Example
{
  "object-name": "string",
  "priority-decrement": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Delete operation of resource: tracked-object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Retrieve operation of resource: tracked-object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "object-name": "string",
  "priority-decrement": "integer"
}

BFD - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/bfd/

Update operation of resource: bfd

bfdbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "interval": "integer",
  "detection-multiplier": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/bfd/

Create operation of resource: bfd

bfdbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "interval": "integer",
  "detection-multiplier": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/bfd/

Delete operation of resource: bfd

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/bfd/

Retrieve operation of resource: bfd

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "interval": "integer",
  "detection-multiplier": "integer"
}

SNMP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/

Update operation of resource: snmp

snmpbody object

Request Content-Types: application/json
Request Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/

Create operation of resource: snmp

snmpbody object

Request Content-Types: application/json
Request Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/

Delete operation of resource: snmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/

Retrieve operation of resource: snmp

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

ENCRYPTED-COMMUNITY-MAPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Update operation of resource: encrypted-community-maps

encrypted-community-mapsbody object

Request Content-Types: application/json
Request Example
{    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Create operation of resource: encrypted-community-maps

encrypted-community-mapsbody object

Request Content-Types: application/json
Request Example
{    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Delete operation of resource: encrypted-community-maps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Retrieve operation of resource: encrypted-community-maps

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

ENCRYPTED-COMMUNITY-MAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Update operation of resource: encrypted-community-map

encrypted-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Create operation of resource: encrypted-community-map

encrypted-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Delete operation of resource: encrypted-community-map

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Retrieve operation of resource: encrypted-community-map

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

VIEWS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Update operation of resource: views

viewsbody object

Request Content-Types: application/json
Request Example
{    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Create operation of resource: views

viewsbody object

Request Content-Types: application/json
Request Example
{    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Delete operation of resource: views

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Retrieve operation of resource: views

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}

VIEW - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Update operation of resource: view

viewbody object

view-name family: string
in path

ID of view-name family

Request Content-Types: application/json
Request Example
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Create operation of resource: view

viewbody object

view-name family: string
in path

ID of view-name family

Request Content-Types: application/json
Request Example
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Delete operation of resource: view

view-name family: string
in path

ID of view-name family

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Retrieve operation of resource: view

view-name family: string
in path

ID of view-name family

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}

LOGGING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Update operation of resource: logging

loggingbody object

Request Content-Types: application/json
Request Example
{    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Create operation of resource: logging

loggingbody object

Request Content-Types: application/json
Request Example
{    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Delete operation of resource: logging

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Retrieve operation of resource: logging

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}

THRESHOLD - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Update operation of resource: threshold

thresholdbody object

Request Content-Types: application/json
Request Example
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Create operation of resource: threshold

thresholdbody object

Request Content-Types: application/json
Request Example
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Delete operation of resource: threshold

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Retrieve operation of resource: threshold

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}

ADMINISTRATION - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Update operation of resource: administration

administrationbody object

Request Content-Types: application/json
Request Example
{      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Create operation of resource: administration

administrationbody object

Request Content-Types: application/json
Request Example
{      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Delete operation of resource: administration

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Retrieve operation of resource: administration

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}

DEFAULT-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Update operation of resource: default-communities

default-communitiesbody object

Request Content-Types: application/json
Request Example
{    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Create operation of resource: default-communities

default-communitiesbody object

Request Content-Types: application/json
Request Example
{    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Delete operation of resource: default-communities

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Retrieve operation of resource: default-communities

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

DEFAULT-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Update operation of resource: default-community

default-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Create operation of resource: default-community

default-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Delete operation of resource: default-community

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Retrieve operation of resource: default-community

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

ENCRYPTED-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Update operation of resource: encrypted-communities

encrypted-communitiesbody object

Request Content-Types: application/json
Request Example
{    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Create operation of resource: encrypted-communities

encrypted-communitiesbody object

Request Content-Types: application/json
Request Example
{    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Delete operation of resource: encrypted-communities

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Retrieve operation of resource: encrypted-communities

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

ENCRYPTED-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Update operation of resource: encrypted-community

encrypted-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Create operation of resource: encrypted-community

encrypted-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Delete operation of resource: encrypted-community

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Retrieve operation of resource: encrypted-community

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

AGENT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Update operation of resource: agent

agentbody object

Request Content-Types: application/json
Request Example
{        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Create operation of resource: agent

agentbody object

Request Content-Types: application/json
Request Example
{        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Delete operation of resource: agent

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Retrieve operation of resource: agent

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}

ENGINE-ID - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Update operation of resource: engine-id

engine-idbody object

Request Content-Types: application/json
Request Example
{      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Create operation of resource: engine-id

engine-idbody object

Request Content-Types: application/json
Request Example
{      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Delete operation of resource: engine-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Retrieve operation of resource: engine-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}

REMOTES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Update operation of resource: remotes

remotesbody object

Request Content-Types: application/json
Request Example
{    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Create operation of resource: remotes

remotesbody object

Request Content-Types: application/json
Request Example
{    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Delete operation of resource: remotes

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Retrieve operation of resource: remotes

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}

REMOTE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Update operation of resource: remote

remotebody object

remote-address: string
in path

ID of remote-address

Request Content-Types: application/json
Request Example
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Create operation of resource: remote

remotebody object

remote-address: string
in path

ID of remote-address

Request Content-Types: application/json
Request Example
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Delete operation of resource: remote

remote-address: string
in path

ID of remote-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Retrieve operation of resource: remote

remote-address: string
in path

ID of remote-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}

TRAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Update operation of resource: trap

trapbody object

Request Content-Types: application/json
Request Example
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Create operation of resource: trap

trapbody object

Request Content-Types: application/json
Request Example
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Delete operation of resource: trap

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Retrieve operation of resource: trap

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}

DROP-PACKET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Update operation of resource: drop-packet

drop-packetbody object

Request Content-Types: application/json
Request Example
{
  "unknown-user": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Create operation of resource: drop-packet

drop-packetbody object

Request Content-Types: application/json
Request Example
{
  "unknown-user": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Delete operation of resource: drop-packet

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Retrieve operation of resource: drop-packet

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "unknown-user": [ null ]
}

IPV6 - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Update operation of resource: ipv6

ipv6body object

Request Content-Types: application/json
Request Example
{    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Create operation of resource: ipv6

ipv6body object

Request Content-Types: application/json
Request Example
{    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Delete operation of resource: ipv6

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Retrieve operation of resource: ipv6

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

TOS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Update operation of resource: tos

tosbody object

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Create operation of resource: tos

tosbody object

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Delete operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Retrieve operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

IPV4 - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Update operation of resource: ipv4

ipv4body object

Request Content-Types: application/json
Request Example
{    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Create operation of resource: ipv4

ipv4body object

Request Content-Types: application/json
Request Example
{    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Delete operation of resource: ipv4

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Retrieve operation of resource: ipv4

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

TOS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Update operation of resource: tos

tosbody object

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Create operation of resource: tos

tosbody object

Request Content-Types: application/json
Request Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Delete operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Retrieve operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

SYSTEM - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Update operation of resource: system

systembody object

Request Content-Types: application/json
Request Example
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Create operation of resource: system

systembody object

Request Content-Types: application/json
Request Example
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Delete operation of resource: system

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Retrieve operation of resource: system

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}

TARGET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Update operation of resource: target

targetbody object

Request Content-Types: application/json
Request Example
{      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",      {
        "name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Create operation of resource: target

targetbody object

Request Content-Types: application/json
Request Example
{      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",      {
        "name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Delete operation of resource: target

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Retrieve operation of resource: target

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",      {
        "name": "string"
      }
    ]
  }
}

TARGETS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Update operation of resource: targets

targetsbody object

Request Content-Types: application/json
Request Example
{    {          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",          {
            "name": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Create operation of resource: targets

targetsbody object

Request Content-Types: application/json
Request Example
{    {          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",          {
            "name": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Delete operation of resource: targets

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Retrieve operation of resource: targets

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",          {
            "name": "string"
          }
        ]
      }
    }
  ]
}

TARGET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Update operation of resource: target

targetbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",      {
        "name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Create operation of resource: target

targetbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",      {
        "name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Delete operation of resource: target

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Retrieve operation of resource: target

target-list-name: string
in path

ID of target-list-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",      {
        "name": "string"
      }
    ]
  }
}

VRF-NAMES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Update operation of resource: vrf-names

vrf-namesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{    {
      "name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Create operation of resource: vrf-names

vrf-namesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{    {
      "name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Delete operation of resource: vrf-names

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Retrieve operation of resource: vrf-names

target-list-name: string
in path

ID of target-list-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "name": "string"
    }
  ]
}

VRF-NAME - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Update operation of resource: vrf-name

vrf-namebody object

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Create operation of resource: vrf-name

vrf-namebody object

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Delete operation of resource: vrf-name

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Retrieve operation of resource: vrf-name

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "name": "string"
}

TARGET-ADDRESSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Update operation of resource: target-addresses

target-addressesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Create operation of resource: target-addresses

target-addressesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{    {
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Delete operation of resource: target-addresses

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Retrieve operation of resource: target-addresses

target-list-name: string
in path

ID of target-list-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "ip-address": "string"
    }
  ]
}

TARGET-ADDRESS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Update operation of resource: target-address

target-addressbody object

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Create operation of resource: target-address

target-addressbody object

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Delete operation of resource: target-address

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Retrieve operation of resource: target-address

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "ip-address": "string"
}

NOTIFICATION - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Update operation of resource: notification

notificationbody object

Request Content-Types: application/json
Request Example
{    "enable": [ null ]
  },    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Create operation of resource: notification

notificationbody object

Request Content-Types: application/json
Request Example
{    "enable": [ null ]
  },    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Delete operation of resource: notification

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Retrieve operation of resource: notification

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "enable": [ null ]
  },    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  }
}

SNMP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Update operation of resource: snmp

snmpbody object

Request Content-Types: application/json
Request Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Create operation of resource: snmp

snmpbody object

Request Content-Types: application/json
Request Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Delete operation of resource: snmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Retrieve operation of resource: snmp

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

VRRP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/vrrp/

Update operation of resource: vrrp

vrrpbody object

Request Content-Types: application/json
Request Example
{
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRRP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/vrrp/

Create operation of resource: vrrp

vrrpbody object

Request Content-Types: application/json
Request Example
{
  "enable": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRRP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/vrrp/

Delete operation of resource: vrrp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRRP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/vrrp/

Retrieve operation of resource: vrrp

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "enable": [ null ]
}

CORRELATOR - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Update operation of resource: correlator

correlatorbody object

Request Content-Types: application/json
Request Example
{      {            {
              "oid": "string",
              "created": [ null ],                  {
                    "oid": "string",                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",            {
              "oid": "string",
              "created": [ null ],                  {
                    "oid": "string",                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",          "all": [ null ],              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },      {
        "name": "string",            {
              "rulename": "string"
            }
          ]
        },          "all": [ null ],              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Create operation of resource: correlator

correlatorbody object

Request Content-Types: application/json
Request Example
{      {            {
              "oid": "string",
              "created": [ null ],                  {
                    "oid": "string",                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",            {
              "oid": "string",
              "created": [ null ],                  {
                    "oid": "string",                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",          "all": [ null ],              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },      {
        "name": "string",            {
              "rulename": "string"
            }
          ]
        },          "all": [ null ],              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Delete operation of resource: correlator

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Retrieve operation of resource: correlator

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {            {
              "oid": "string",
              "created": [ null ],                  {
                    "oid": "string",                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",            {
              "oid": "string",
              "created": [ null ],                  {
                    "oid": "string",                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",          "all": [ null ],              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },      {
        "name": "string",            {
              "rulename": "string"
            }
          ]
        },          "all": [ null ],              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}

RULES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Update operation of resource: rules

rulesbody object

Request Content-Types: application/json
Request Example
{    {          {
            "oid": "string",
            "created": [ null ],                {
                  "oid": "string",                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",          {
            "oid": "string",
            "created": [ null ],                {
                  "oid": "string",                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",        "all": [ null ],            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Create operation of resource: rules

rulesbody object

Request Content-Types: application/json
Request Example
{    {          {
            "oid": "string",
            "created": [ null ],                {
                  "oid": "string",                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",          {
            "oid": "string",
            "created": [ null ],                {
                  "oid": "string",                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",        "all": [ null ],            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Delete operation of resource: rules

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Retrieve operation of resource: rules

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {
            "oid": "string",
            "created": [ null ],                {
                  "oid": "string",                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",          {
            "oid": "string",
            "created": [ null ],                {
                  "oid": "string",                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",        "all": [ null ],            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

RULE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Update operation of resource: rule

rulebody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {
        "oid": "string",
        "created": [ null ],            {
              "oid": "string",                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",      {
        "oid": "string",
        "created": [ null ],            {
              "oid": "string",                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",    "all": [ null ],        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Create operation of resource: rule

rulebody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {
        "oid": "string",
        "created": [ null ],            {
              "oid": "string",                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",      {
        "oid": "string",
        "created": [ null ],            {
              "oid": "string",                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",    "all": [ null ],        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Delete operation of resource: rule

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Retrieve operation of resource: rule

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "oid": "string",
        "created": [ null ],            {
              "oid": "string",                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",      {
        "oid": "string",
        "created": [ null ],            {
              "oid": "string",                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",    "all": [ null ],        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

ROOT-CAUSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Update operation of resource: root-causes

root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      "oid": "string",
      "created": [ null ],          {
            "oid": "string",              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Create operation of resource: root-causes

root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      "oid": "string",
      "created": [ null ],          {
            "oid": "string",              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Delete operation of resource: root-causes

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Retrieve operation of resource: root-causes

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "oid": "string",
      "created": [ null ],          {
            "oid": "string",              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

ROOT-CAUSE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Update operation of resource: root-cause

root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  "created": [ null ],      {
        "oid": "string",          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Create operation of resource: root-cause

root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  "created": [ null ],      {
        "oid": "string",          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Delete operation of resource: root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Retrieve operation of resource: root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "string",
  "created": [ null ],      {
        "oid": "string",          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

VAR-BINDS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Update operation of resource: var-binds

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    {
      "oid": "string",        "index": "string",
        "value": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Create operation of resource: var-binds

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    {
      "oid": "string",        "index": "string",
        "value": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Delete operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Retrieve operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "oid": "string",        "index": "string",
        "value": "string"
      }
    }
  ]
}

VAR-BIND - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Update operation of resource: var-bind

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",    "index": "string",
    "value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Create operation of resource: var-bind

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",    "index": "string",
    "value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Delete operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Retrieve operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "string",    "index": "string",
    "value": "string"
  }
}

MATCH - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Update operation of resource: match

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "index": "string",
  "value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Create operation of resource: match

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "index": "string",
  "value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Delete operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Retrieve operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "index": "string",
  "value": "string"
}

NON-ROOT-CAUSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Update operation of resource: non-root-causes

non-root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      "oid": "string",
      "created": [ null ],          {
            "oid": "string",              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Create operation of resource: non-root-causes

non-root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      "oid": "string",
      "created": [ null ],          {
            "oid": "string",              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Delete operation of resource: non-root-causes

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Retrieve operation of resource: non-root-causes

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "oid": "string",
      "created": [ null ],          {
            "oid": "string",              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

NON-ROOT-CAUSE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Update operation of resource: non-root-cause

non-root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  "created": [ null ],      {
        "oid": "string",          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Create operation of resource: non-root-cause

non-root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",
  "created": [ null ],      {
        "oid": "string",          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Delete operation of resource: non-root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Retrieve operation of resource: non-root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "string",
  "created": [ null ],      {
        "oid": "string",          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

VAR-BINDS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Update operation of resource: var-binds

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    {
      "oid": "string",        "index": "string",
        "value": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Create operation of resource: var-binds

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    {
      "oid": "string",        "index": "string",
        "value": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Delete operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Retrieve operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "oid": "string",        "index": "string",
        "value": "string"
      }
    }
  ]
}

VAR-BIND - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Update operation of resource: var-bind

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",    "index": "string",
    "value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Create operation of resource: var-bind

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string",    "index": "string",
    "value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Delete operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Retrieve operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "string",    "index": "string",
    "value": "string"
  }
}

MATCH - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Update operation of resource: match

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "index": "string",
  "value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Create operation of resource: match

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "index": "string",
  "value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Delete operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Retrieve operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "index": "string",
  "value": "string"
}

APPLIED-TO - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Update operation of resource: applied-to

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "all": [ null ],      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Create operation of resource: applied-to

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "all": [ null ],      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Delete operation of resource: applied-to

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Retrieve operation of resource: applied-to

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "all": [ null ],      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Update operation of resource: hosts

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Create operation of resource: hosts

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Delete operation of resource: hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Retrieve operation of resource: hosts

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Update operation of resource: host

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Create operation of resource: host

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Delete operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Retrieve operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "port": "string",
  "ip-address": "string"
}

RULE-SETS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Update operation of resource: rule-sets

rule-setsbody object

Request Content-Types: application/json
Request Example
{    {
      "name": "string",          {
            "rulename": "string"
          }
        ]
      },        "all": [ null ],            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Create operation of resource: rule-sets

rule-setsbody object

Request Content-Types: application/json
Request Example
{    {
      "name": "string",          {
            "rulename": "string"
          }
        ]
      },        "all": [ null ],            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Delete operation of resource: rule-sets

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Retrieve operation of resource: rule-sets

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "name": "string",          {
            "rulename": "string"
          }
        ]
      },        "all": [ null ],            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

RULE-SET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Update operation of resource: rule-set

rule-setbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",      {
        "rulename": "string"
      }
    ]
  },    "all": [ null ],        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Create operation of resource: rule-set

rule-setbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",      {
        "rulename": "string"
      }
    ]
  },    "all": [ null ],        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Delete operation of resource: rule-set

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Retrieve operation of resource: rule-set

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "name": "string",      {
        "rulename": "string"
      }
    ]
  },    "all": [ null ],        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

RULENAMES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Update operation of resource: rulenames

rulenamesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      "rulename": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Create operation of resource: rulenames

rulenamesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      "rulename": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Delete operation of resource: rulenames

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Retrieve operation of resource: rulenames

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "rulename": "string"
    }
  ]
}

RULENAME - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Update operation of resource: rulename

rulenamebody object

name: string
in path

ID of name

rulename: string
in path

ID of rulename

Request Content-Types: application/json
Request Example
{
  "rulename": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Create operation of resource: rulename

rulenamebody object

name: string
in path

ID of name

rulename: string
in path

ID of rulename

Request Content-Types: application/json
Request Example
{
  "rulename": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Delete operation of resource: rulename

name: string
in path

ID of name

rulename: string
in path

ID of rulename

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Retrieve operation of resource: rulename

name: string
in path

ID of name

rulename: string
in path

ID of rulename

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "rulename": "string"
}

APPLIED-TO - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Update operation of resource: applied-to

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "all": [ null ],      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Create operation of resource: applied-to

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "all": [ null ],      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Delete operation of resource: applied-to

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Retrieve operation of resource: applied-to

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "all": [ null ],      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Update operation of resource: hosts

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Create operation of resource: hosts

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Delete operation of resource: hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Retrieve operation of resource: hosts

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Update operation of resource: host

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Create operation of resource: host

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "ip-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Delete operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Retrieve operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "port": "string",
  "ip-address": "string"
}

BULK-STATS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Update operation of resource: bulk-stats

bulk-statsbody object

Request Content-Types: application/json
Request Example
{
  "memory": "integer",      {
        "retry": "integer",            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },      {
        "object-list-name": "string",            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },      {
        "schema-name": "string",          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Create operation of resource: bulk-stats

bulk-statsbody object

Request Content-Types: application/json
Request Example
{
  "memory": "integer",      {
        "retry": "integer",            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },      {
        "object-list-name": "string",            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },      {
        "schema-name": "string",          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Delete operation of resource: bulk-stats

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Retrieve operation of resource: bulk-stats

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "memory": "integer",      {
        "retry": "integer",            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },      {
        "object-list-name": "string",            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },      {
        "schema-name": "string",          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}

SCHEMAS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Update operation of resource: schemas

schemasbody object

Request Content-Types: application/json
Request Example
{    {
      "schema-name": "string",        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Create operation of resource: schemas

schemasbody object

Request Content-Types: application/json
Request Example
{    {
      "schema-name": "string",        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Delete operation of resource: schemas

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Retrieve operation of resource: schemas

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "schema-name": "string",        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}

SCHEMA - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Update operation of resource: schema

schemabody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "schema-name": "string",    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Create operation of resource: schema

schemabody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "schema-name": "string",    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Delete operation of resource: schema

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Retrieve operation of resource: schema

schema-name: string
in path

ID of schema-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "schema-name": "string",    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}

INSTANCE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Update operation of resource: instance

instancebody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Create operation of resource: instance

instancebody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Delete operation of resource: instance

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Retrieve operation of resource: instance

schema-name: string
in path

ID of schema-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}

OBJECTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Update operation of resource: objects

objectsbody object

Request Content-Types: application/json
Request Example
{    {
      "oid": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Create operation of resource: objects

objectsbody object

Request Content-Types: application/json
Request Example
{    {
      "oid": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Delete operation of resource: objects

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Retrieve operation of resource: objects

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "oid": "string"
    }
  ]
}

OBJECT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Update operation of resource: object

objectbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  "oid": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Create operation of resource: object

objectbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  "oid": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Delete operation of resource: object

object-list-name: string
in path

ID of object-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Retrieve operation of resource: object

object-list-name: string
in path

ID of object-list-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "string"
}

OBJECTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Update operation of resource: objects

objectsbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{    {
      "oid": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Create operation of resource: objects

objectsbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{    {
      "oid": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Delete operation of resource: objects

object-list-name: string
in path

ID of object-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Retrieve operation of resource: objects

object-list-name: string
in path

ID of object-list-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "oid": "string"
    }
  ]
}

OBJECT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Update operation of resource: object

objectbody object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Create operation of resource: object

objectbody object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  "oid": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Delete operation of resource: object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Retrieve operation of resource: object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "string"
}

TRANSFERS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Update operation of resource: transfers

transfersbody object

Request Content-Types: application/json
Request Example
{    {
      "retry": "integer",          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Create operation of resource: transfers

transfersbody object

Request Content-Types: application/json
Request Example
{    {
      "retry": "integer",          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Delete operation of resource: transfers

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Retrieve operation of resource: transfers

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "retry": "integer",          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}

TRANSFER - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Update operation of resource: transfer

transferbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  "retry": "integer",      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Create operation of resource: transfer

transferbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  "retry": "integer",      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Delete operation of resource: transfer

transfer-name: string
in path

ID of transfer-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Retrieve operation of resource: transfer

transfer-name: string
in path

ID of transfer-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "retry": "integer",      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}

TRANSFER-SCHEMAS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Update operation of resource: transfer-schemas

transfer-schemasbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{    {
      "schema-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Create operation of resource: transfer-schemas

transfer-schemasbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{    {
      "schema-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Delete operation of resource: transfer-schemas

transfer-name: string
in path

ID of transfer-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Retrieve operation of resource: transfer-schemas

transfer-name: string
in path

ID of transfer-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "schema-name": "string"
    }
  ]
}

TRANSFER-SCHEMA - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Update operation of resource: transfer-schema

transfer-schemabody object

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "schema-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Create operation of resource: transfer-schema

transfer-schemabody object

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  "schema-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Delete operation of resource: transfer-schema

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Retrieve operation of resource: transfer-schema

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "schema-name": "string"
}

DEFAULT-COMMUNITY-MAPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Update operation of resource: default-community-maps

default-community-mapsbody object

Request Content-Types: application/json
Request Example
{    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Create operation of resource: default-community-maps

default-community-mapsbody object

Request Content-Types: application/json
Request Example
{    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Delete operation of resource: default-community-maps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Retrieve operation of resource: default-community-maps

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

DEFAULT-COMMUNITY-MAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Update operation of resource: default-community-map

default-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Create operation of resource: default-community-map

default-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Delete operation of resource: default-community-map

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Retrieve operation of resource: default-community-map

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

OVERLOAD-CONTROL - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Update operation of resource: overload-control

overload-controlbody object

Request Content-Types: application/json
Request Example
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Create operation of resource: overload-control

overload-controlbody object

Request Content-Types: application/json
Request Example
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Delete operation of resource: overload-control

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Retrieve operation of resource: overload-control

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}

TIMEOUTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Update operation of resource: timeouts

timeoutsbody object

Request Content-Types: application/json
Request Example
{
  "duplicates": "integer",
  "threshold": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Create operation of resource: timeouts

timeoutsbody object

Request Content-Types: application/json
Request Example
{
  "duplicates": "integer",
  "threshold": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Delete operation of resource: timeouts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Retrieve operation of resource: timeouts

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "duplicates": "integer",
  "threshold": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}

USERS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Update operation of resource: users

usersbody object

Request Content-Types: application/json
Request Example
{    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Create operation of resource: users

usersbody object

Request Content-Types: application/json
Request Example
{    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Delete operation of resource: users

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Retrieve operation of resource: users

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}

USER - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Update operation of resource: user

userbody object

user-name: string
in path

ID of user-name

Request Content-Types: application/json
Request Example
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Create operation of resource: user

userbody object

user-name: string
in path

ID of user-name

Request Content-Types: application/json
Request Example
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Delete operation of resource: user

user-name: string
in path

ID of user-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Retrieve operation of resource: user

user-name: string
in path

ID of user-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}

VRFS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Update operation of resource: vrfs

vrfsbody object

Request Content-Types: application/json
Request Example
{    {
      "name": "string",          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Create operation of resource: vrfs

vrfsbody object

Request Content-Types: application/json
Request Example
{    {
      "name": "string",          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Delete operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Retrieve operation of resource: vrfs

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "name": "string",          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}

VRF - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Update operation of resource: vrf

vrfbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Create operation of resource: vrf

vrfbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Delete operation of resource: vrf

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Retrieve operation of resource: vrf

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "name": "string",      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

TRAP-HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Update operation of resource: trap-hosts

trap-hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Create operation of resource: trap-hosts

trap-hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Delete operation of resource: trap-hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Retrieve operation of resource: trap-hosts

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

TRAP-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Update operation of resource: trap-host

trap-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Create operation of resource: trap-host

trap-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Delete operation of resource: trap-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Retrieve operation of resource: trap-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Update operation of resource: encrypted-user-communities

encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Create operation of resource: encrypted-user-communities

encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Delete operation of resource: encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Retrieve operation of resource: encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Update operation of resource: encrypted-user-community

encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Create operation of resource: encrypted-user-community

encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Delete operation of resource: encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Retrieve operation of resource: encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Update operation of resource: inform-host

inform-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Create operation of resource: inform-host

inform-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Delete operation of resource: inform-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Retrieve operation of resource: inform-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

INFORM-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Update operation of resource: inform-user-communities

inform-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Create operation of resource: inform-user-communities

inform-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Delete operation of resource: inform-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Retrieve operation of resource: inform-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Update operation of resource: inform-user-community

inform-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Create operation of resource: inform-user-community

inform-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Delete operation of resource: inform-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Retrieve operation of resource: inform-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Update operation of resource: inform-encrypted-user-communities

inform-encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Create operation of resource: inform-encrypted-user-communities

inform-encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Delete operation of resource: inform-encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Retrieve operation of resource: inform-encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Update operation of resource: inform-encrypted-user-community

inform-encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Create operation of resource: inform-encrypted-user-community

inform-encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Delete operation of resource: inform-encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Retrieve operation of resource: inform-encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

DEFAULT-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Update operation of resource: default-user-communities

default-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Create operation of resource: default-user-communities

default-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Delete operation of resource: default-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Retrieve operation of resource: default-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

DEFAULT-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Update operation of resource: default-user-community

default-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Create operation of resource: default-user-community

default-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Delete operation of resource: default-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Retrieve operation of resource: default-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

CONTEXTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Update operation of resource: contexts

contextsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      "context-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Create operation of resource: contexts

contextsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      "context-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Delete operation of resource: contexts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Retrieve operation of resource: contexts

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "context-name": "string"
    }
  ]
}

CONTEXT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Update operation of resource: context

contextbody object

name: string
in path

ID of name

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  "context-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Create operation of resource: context

contextbody object

name: string
in path

ID of name

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  "context-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Delete operation of resource: context

name: string
in path

ID of name

context-name: string
in path

ID of context-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Retrieve operation of resource: context

name: string
in path

ID of name

context-name: string
in path

ID of context-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "context-name": "string"
}

CONTEXT-MAPPINGS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Update operation of resource: context-mappings

context-mappingsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Create operation of resource: context-mappings

context-mappingsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Delete operation of resource: context-mappings

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Retrieve operation of resource: context-mappings

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

CONTEXT-MAPPING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Update operation of resource: context-mapping

context-mappingbody object

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Create operation of resource: context-mapping

context-mappingbody object

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Delete operation of resource: context-mapping

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Retrieve operation of resource: context-mapping

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

GROUPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Update operation of resource: groups

groupsbody object

Request Content-Types: application/json
Request Example
{    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Create operation of resource: groups

groupsbody object

Request Content-Types: application/json
Request Example
{    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Delete operation of resource: groups

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Retrieve operation of resource: groups

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}

GROUP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Update operation of resource: group

groupbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Create operation of resource: group

groupbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Delete operation of resource: group

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Retrieve operation of resource: group

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}

TRAP-HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Update operation of resource: trap-hosts

trap-hostsbody object

Request Content-Types: application/json
Request Example
{    {          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Create operation of resource: trap-hosts

trap-hostsbody object

Request Content-Types: application/json
Request Example
{    {          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Delete operation of resource: trap-hosts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Retrieve operation of resource: trap-hosts

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

TRAP-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Update operation of resource: trap-host

trap-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Create operation of resource: trap-host

trap-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Delete operation of resource: trap-host

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Retrieve operation of resource: trap-host

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Update operation of resource: encrypted-user-communities

encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Create operation of resource: encrypted-user-communities

encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Delete operation of resource: encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Retrieve operation of resource: encrypted-user-communities

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Update operation of resource: encrypted-user-community

encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Create operation of resource: encrypted-user-community

encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Delete operation of resource: encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Retrieve operation of resource: encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Update operation of resource: inform-host

inform-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Create operation of resource: inform-host

inform-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Delete operation of resource: inform-host

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Retrieve operation of resource: inform-host

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

INFORM-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Update operation of resource: inform-user-communities

inform-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Create operation of resource: inform-user-communities

inform-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Delete operation of resource: inform-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Retrieve operation of resource: inform-user-communities

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Update operation of resource: inform-user-community

inform-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Create operation of resource: inform-user-community

inform-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Delete operation of resource: inform-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Retrieve operation of resource: inform-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

INFORM-ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Update operation of resource: inform-encrypted-user-communities

inform-encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Create operation of resource: inform-encrypted-user-communities

inform-encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Delete operation of resource: inform-encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Retrieve operation of resource: inform-encrypted-user-communities

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

INFORM-ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Update operation of resource: inform-encrypted-user-community

inform-encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Create operation of resource: inform-encrypted-user-community

inform-encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Delete operation of resource: inform-encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Retrieve operation of resource: inform-encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

DEFAULT-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Update operation of resource: default-user-communities

default-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Create operation of resource: default-user-communities

default-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Delete operation of resource: default-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Retrieve operation of resource: default-user-communities

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

DEFAULT-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Update operation of resource: default-user-community

default-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Create operation of resource: default-user-community

default-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Delete operation of resource: default-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Retrieve operation of resource: default-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

CONTEXTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Update operation of resource: contexts

contextsbody object

Request Content-Types: application/json
Request Example
{    {
      "context-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Create operation of resource: contexts

contextsbody object

Request Content-Types: application/json
Request Example
{    {
      "context-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Delete operation of resource: contexts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Retrieve operation of resource: contexts

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "context-name": "string"
    }
  ]
}

CONTEXT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Update operation of resource: context

contextbody object

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  "context-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Create operation of resource: context

contextbody object

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  "context-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Delete operation of resource: context

context-name: string
in path

ID of context-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Retrieve operation of resource: context

context-name: string
in path

ID of context-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "context-name": "string"
}

CONTEXT-MAPPINGS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Update operation of resource: context-mappings

context-mappingsbody object

Request Content-Types: application/json
Request Example
{    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Create operation of resource: context-mappings

context-mappingsbody object

Request Content-Types: application/json
Request Example
{    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Delete operation of resource: context-mappings

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Retrieve operation of resource: context-mappings

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

CONTEXT-MAPPING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Update operation of resource: context-mapping

context-mappingbody object

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Create operation of resource: context-mapping

context-mappingbody object

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Delete operation of resource: context-mapping

context-mapping-name: string
in path

ID of context-mapping-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Retrieve operation of resource: context-mapping

context-mapping-name: string
in path

ID of context-mapping-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

MIB - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:mib/

Update operation of resource: mib

mibbody object

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Create

POST Cisco-IOS-XR-snmp-agent-cfg:mib/

Create operation of resource: mib

mibbody object

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:mib/

Delete operation of resource: mib

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:mib/

Retrieve operation of resource: mib

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)

Schema Definitions

vrrp_schema:

VRRP configuration

interfaces: object

Interface configuration table

interface: object[]

The interface being configured

object
mac-refresh: integer

VRRP Slave MAC-refresh rate in seconds

range:"0..10000" units:"second" default:"60"
delay: object

Minimum and Reload Delay

reload-delay: integer

Reload delay in seconds

range:"0..10000" units:"second"
min-delay: integer

Minimum delay in seconds

range:"0..10000" units:"second"
interface-name: string

Interface name to configure

bfd: object

BFD configuration

interval: integer

Hello interval for BFD sessions created by vrrp

units:"millisecond"
detection-multiplier: integer

Detection multiplier for BFD sessions created by vrrp

range:"2..50"
ipv6: object

IPv6 VRRP configuration

slave-virtual-routers: object

The VRRP slave group configuration table

slave-virtual-router: object[]

The VRRP slave being configured

object
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

follow: string

VRRP Session name for this slave to follow

link-local-ipv6-address: object

The VRRP IPv6 virtual linklocal address

auto-configure: boolean

TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured

ip-address: string

VRRP IPv6 virtual linklocal address

slave-virtual-router-id: integer

Virtual Router ID

range:"1..255"
global-ipv6-addresses: object

The table of VRRP virtual global IPv6 addresses

global-ipv6-address: object[]

A VRRP virtual global IPv6 IP address

object
ip-address: string

VRRP virtual global IPv6 address

version3: object

Version 3 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
link-local-ipv6-address: object

The VRRP IPv6 virtual linklocal address

auto-configure: boolean

TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured

ip-address: string

VRRP IPv6 virtual linklocal address

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
global-ipv6-addresses: object

The table of VRRP virtual global IPv6 addresses

global-ipv6-address: object[]

A VRRP virtual global IPv6 IP address

object
ip-address: string

VRRP virtual global IPv6 address

priority: integer

Priority value

range:"1..254" default:"100"
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

session-name: string

VRRP Session Name

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
ipv4: object

IPv4 VRRP configuration

slave-virtual-routers: object

The VRRP slave group configuration table

slave-virtual-router: object[]

The VRRP slave being configured

object
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

follow: string

VRRP Session name for this slave to follow

slave-virtual-router-id: integer

Virtual Router ID

range:"1..255"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

primary-ipv4-address: string

The Primary VRRP IPv4 address

version2: object

Version 2 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
primary-ipv4-address: string

The Primary VRRP IPv4 address

priority: integer

Priority value

range:"1..254" default:"100"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
text-password: string

Authentication password, 8 chars max

version3: object

Version 3 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

primary-ipv4-address: string

The Primary VRRP IPv4 address

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
priority: integer

Priority value

range:"1..254" default:"100"
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
enable: null

Enable vrrp process

logging: object

VRRP logging options

state-change-disable: null

VRRP state change IOS messages disable

Example
{
  "interfaces": {
    "interface": [
      {
        "mac-refresh": "integer",
        "delay": {
          "reload-delay": "integer",
          "min-delay": "integer"
        },
        "interface-name": "string",
        "bfd": {
          "interval": "integer",
          "detection-multiplier": "integer"
        },
        "ipv6": {
          "slave-virtual-routers": {
            "slave-virtual-router": [
              {
                "accept-mode-disable": [ null ],
                "follow": "string",
                "link-local-ipv6-address": {
                  "auto-configure": "boolean",
                  "ip-address": "string"
                },
                "slave-virtual-router-id": "integer",
                "global-ipv6-addresses": {
                  "global-ipv6-address": [
                    {
                      "ip-address": "string"
                    }
                  ]
                }
              }
            ]
          },
          "version3": {
            "virtual-routers": {
              "virtual-router": [
                {
                  "link-local-ipv6-address": {
                    "auto-configure": "boolean",
                    "ip-address": "string"
                  },
                  "bfd": "string",
                  "tracks": {
                    "track": [
                      {
                        "priority": "integer",
                        "interface-name": "string"
                      }
                    ]
                  },
                  "timer": {
                    "advertisement-time-in-msec": "integer",
                    "forced": [ null ],
                    "advertisement-time-in-sec": "integer"
                  },
                  "global-ipv6-addresses": {
                    "global-ipv6-address": [
                      {
                        "ip-address": "string"
                      }
                    ]
                  },
                  "priority": "integer",
                  "tracked-objects": {
                    "tracked-object": [
                      {
                        "object-name": "string",
                        "priority-decrement": "integer"
                      }
                    ]
                  },
                  "accept-mode-disable": [ null ],
                  "session-name": "string",
                  "vr-id": "integer",
                  "preempt": "integer"
                }
              ]
            }
          }
        },
        "ipv4": {
          "slave-virtual-routers": {
            "slave-virtual-router": [
              {
                "accept-mode-disable": [ null ],
                "follow": "string",
                "slave-virtual-router-id": "integer",
                "secondary-ipv4-addresses": {
                  "secondary-ipv4-address": [
                    {
                      "ip-address": "string"
                    }
                  ]
                },
                "primary-ipv4-address": "string"
              }
            ]
          },
          "version2": {
            "virtual-routers": {
              "virtual-router": [
                {
                  "tracked-objects": {
                    "tracked-object": [
                      {
                        "object-name": "string",
                        "priority-decrement": "integer"
                      }
                    ]
                  },
                  "session-name": "string",
                  "bfd": "string",
                  "tracks": {
                    "track": [
                      {
                        "priority": "integer",
                        "interface-name": "string"
                      }
                    ]
                  },
                  "timer": {
                    "advertisement-time-in-msec": "integer",
                    "forced": [ null ],
                    "advertisement-time-in-sec": "integer"
                  },
                  "primary-ipv4-address": "string",
                  "priority": "integer",
                  "preempt": "integer",
                  "secondary-ipv4-addresses": {
                    "secondary-ipv4-address": [
                      {
                        "ip-address": "string"
                      }
                    ]
                  },
                  "accept-mode-disable": [ null ],
                  "vr-id": "integer",
                  "text-password": "string"
                }
              ]
            }
          },
          "version3": {}
        }
      }
    ]
  }
}

logging_schema:

VRRP logging options

state-change-disable: null

VRRP state change IOS messages disable

Example
{
  "state-change-disable": [ null ]
}

interfaces_schema:

Interface configuration table

interface: object[]

The interface being configured

object
mac-refresh: integer

VRRP Slave MAC-refresh rate in seconds

range:"0..10000" units:"second" default:"60"
delay: object

Minimum and Reload Delay

reload-delay: integer

Reload delay in seconds

range:"0..10000" units:"second"
min-delay: integer

Minimum delay in seconds

range:"0..10000" units:"second"
interface-name: string

Interface name to configure

bfd: object

BFD configuration

interval: integer

Hello interval for BFD sessions created by vrrp

units:"millisecond"
detection-multiplier: integer

Detection multiplier for BFD sessions created by vrrp

range:"2..50"
ipv6: object

IPv6 VRRP configuration

slave-virtual-routers: object

The VRRP slave group configuration table

slave-virtual-router: object[]

The VRRP slave being configured

object
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

follow: string

VRRP Session name for this slave to follow

link-local-ipv6-address: object

The VRRP IPv6 virtual linklocal address

auto-configure: boolean

TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured

ip-address: string

VRRP IPv6 virtual linklocal address

slave-virtual-router-id: integer

Virtual Router ID

range:"1..255"
global-ipv6-addresses: object

The table of VRRP virtual global IPv6 addresses

global-ipv6-address: object[]

A VRRP virtual global IPv6 IP address

object
ip-address: string

VRRP virtual global IPv6 address

version3: object

Version 3 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
link-local-ipv6-address: object

The VRRP IPv6 virtual linklocal address

auto-configure: boolean

TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured

ip-address: string

VRRP IPv6 virtual linklocal address

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
global-ipv6-addresses: object

The table of VRRP virtual global IPv6 addresses

global-ipv6-address: object[]

A VRRP virtual global IPv6 IP address

object
ip-address: string

VRRP virtual global IPv6 address

priority: integer

Priority value

range:"1..254" default:"100"
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

session-name: string

VRRP Session Name

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
ipv4: object

IPv4 VRRP configuration

slave-virtual-routers: object

The VRRP slave group configuration table

slave-virtual-router: object[]

The VRRP slave being configured

object
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

follow: string

VRRP Session name for this slave to follow

slave-virtual-router-id: integer

Virtual Router ID

range:"1..255"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

primary-ipv4-address: string

The Primary VRRP IPv4 address

version2: object

Version 2 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
primary-ipv4-address: string

The Primary VRRP IPv4 address

priority: integer

Priority value

range:"1..254" default:"100"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
text-password: string

Authentication password, 8 chars max

version3: object

Version 3 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

primary-ipv4-address: string

The Primary VRRP IPv4 address

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
priority: integer

Priority value

range:"1..254" default:"100"
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
Example
{
  "interface": [
    {
      "mac-refresh": "integer",
      "delay": {
        "reload-delay": "integer",
        "min-delay": "integer"
      },
      "interface-name": "string",
      "bfd": {
        "interval": "integer",
        "detection-multiplier": "integer"
      },
      "ipv6": {
        "slave-virtual-routers": {
          "slave-virtual-router": [
            {
              "accept-mode-disable": [ null ],
              "follow": "string",
              "link-local-ipv6-address": {
                "auto-configure": "boolean",
                "ip-address": "string"
              },
              "slave-virtual-router-id": "integer",
              "global-ipv6-addresses": {
                "global-ipv6-address": [
                  {
                    "ip-address": "string"
                  }
                ]
              }
            }
          ]
        },
        "version3": {
          "virtual-routers": {
            "virtual-router": [
              {
                "link-local-ipv6-address": {
                  "auto-configure": "boolean",
                  "ip-address": "string"
                },
                "bfd": "string",
                "tracks": {
                  "track": [
                    {
                      "priority": "integer",
                      "interface-name": "string"
                    }
                  ]
                },
                "timer": {
                  "advertisement-time-in-msec": "integer",
                  "forced": [ null ],
                  "advertisement-time-in-sec": "integer"
                },
                "global-ipv6-addresses": {
                  "global-ipv6-address": [
                    {
                      "ip-address": "string"
                    }
                  ]
                },
                "priority": "integer",
                "tracked-objects": {
                  "tracked-object": [
                    {
                      "object-name": "string",
                      "priority-decrement": "integer"
                    }
                  ]
                },
                "accept-mode-disable": [ null ],
                "session-name": "string",
                "vr-id": "integer",
                "preempt": "integer"
              }
            ]
          }
        }
      },
      "ipv4": {
        "slave-virtual-routers": {
          "slave-virtual-router": [
            {
              "accept-mode-disable": [ null ],
              "follow": "string",
              "slave-virtual-router-id": "integer",
              "secondary-ipv4-addresses": {
                "secondary-ipv4-address": [
                  {
                    "ip-address": "string"
                  }
                ]
              },
              "primary-ipv4-address": "string"
            }
          ]
        },
        "version2": {
          "virtual-routers": {
            "virtual-router": [
              {
                "tracked-objects": {
                  "tracked-object": [
                    {
                      "object-name": "string",
                      "priority-decrement": "integer"
                    }
                  ]
                },
                "session-name": "string",
                "bfd": "string",
                "tracks": {
                  "track": [
                    {
                      "priority": "integer",
                      "interface-name": "string"
                    }
                  ]
                },
                "timer": {
                  "advertisement-time-in-msec": "integer",
                  "forced": [ null ],
                  "advertisement-time-in-sec": "integer"
                },
                "primary-ipv4-address": "string",
                "priority": "integer",
                "preempt": "integer",
                "secondary-ipv4-addresses": {
                  "secondary-ipv4-address": [
                    {
                      "ip-address": "string"
                    }
                  ]
                },
                "accept-mode-disable": [ null ],
                "vr-id": "integer",
                "text-password": "string"
              }
            ]
          }
        },
        "version3": {
          "virtual-routers": {}
        }
      }
    }
  ]
}

interface_schema:

mac-refresh: integer

VRRP Slave MAC-refresh rate in seconds

range:"0..10000" units:"second" default:"60"
delay: object

Minimum and Reload Delay

reload-delay: integer

Reload delay in seconds

range:"0..10000" units:"second"
min-delay: integer

Minimum delay in seconds

range:"0..10000" units:"second"
interface-name: string

Interface name to configure

bfd: object

BFD configuration

interval: integer

Hello interval for BFD sessions created by vrrp

units:"millisecond"
detection-multiplier: integer

Detection multiplier for BFD sessions created by vrrp

range:"2..50"
ipv6: object

IPv6 VRRP configuration

slave-virtual-routers: object

The VRRP slave group configuration table

slave-virtual-router: object[]

The VRRP slave being configured

object
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

follow: string

VRRP Session name for this slave to follow

link-local-ipv6-address: object

The VRRP IPv6 virtual linklocal address

auto-configure: boolean

TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured

ip-address: string

VRRP IPv6 virtual linklocal address

slave-virtual-router-id: integer

Virtual Router ID

range:"1..255"
global-ipv6-addresses: object

The table of VRRP virtual global IPv6 addresses

global-ipv6-address: object[]

A VRRP virtual global IPv6 IP address

object
ip-address: string

VRRP virtual global IPv6 address

version3: object

Version 3 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
link-local-ipv6-address: object

The VRRP IPv6 virtual linklocal address

auto-configure: boolean

TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured

ip-address: string

VRRP IPv6 virtual linklocal address

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
global-ipv6-addresses: object

The table of VRRP virtual global IPv6 addresses

global-ipv6-address: object[]

A VRRP virtual global IPv6 IP address

object
ip-address: string

VRRP virtual global IPv6 address

priority: integer

Priority value

range:"1..254" default:"100"
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

session-name: string

VRRP Session Name

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
ipv4: object

IPv4 VRRP configuration

slave-virtual-routers: object

The VRRP slave group configuration table

slave-virtual-router: object[]

The VRRP slave being configured

object
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

follow: string

VRRP Session name for this slave to follow

slave-virtual-router-id: integer

Virtual Router ID

range:"1..255"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

primary-ipv4-address: string

The Primary VRRP IPv4 address

version2: object

Version 2 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
primary-ipv4-address: string

The Primary VRRP IPv4 address

priority: integer

Priority value

range:"1..254" default:"100"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
text-password: string

Authentication password, 8 chars max

version3: object

Version 3 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

primary-ipv4-address: string

The Primary VRRP IPv4 address

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
priority: integer

Priority value

range:"1..254" default:"100"
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
Example
{
  "mac-refresh": "integer",
  "delay": {
    "reload-delay": "integer",
    "min-delay": "integer"
  },
  "interface-name": "string",
  "bfd": {
    "interval": "integer",
    "detection-multiplier": "integer"
  },
  "ipv6": {
    "slave-virtual-routers": {
      "slave-virtual-router": [
        {
          "accept-mode-disable": [ null ],
          "follow": "string",
          "link-local-ipv6-address": {
            "auto-configure": "boolean",
            "ip-address": "string"
          },
          "slave-virtual-router-id": "integer",
          "global-ipv6-addresses": {
            "global-ipv6-address": [
              {
                "ip-address": "string"
              }
            ]
          }
        }
      ]
    },
    "version3": {
      "virtual-routers": {
        "virtual-router": [
          {
            "link-local-ipv6-address": {
              "auto-configure": "boolean",
              "ip-address": "string"
            },
            "bfd": "string",
            "tracks": {
              "track": [
                {
                  "priority": "integer",
                  "interface-name": "string"
                }
              ]
            },
            "timer": {
              "advertisement-time-in-msec": "integer",
              "forced": [ null ],
              "advertisement-time-in-sec": "integer"
            },
            "global-ipv6-addresses": {
              "global-ipv6-address": [
                {
                  "ip-address": "string"
                }
              ]
            },
            "priority": "integer",
            "tracked-objects": {
              "tracked-object": [
                {
                  "object-name": "string",
                  "priority-decrement": "integer"
                }
              ]
            },
            "accept-mode-disable": [ null ],
            "session-name": "string",
            "vr-id": "integer",
            "preempt": "integer"
          }
        ]
      }
    }
  },
  "ipv4": {
    "slave-virtual-routers": {
      "slave-virtual-router": [
        {
          "accept-mode-disable": [ null ],
          "follow": "string",
          "slave-virtual-router-id": "integer",
          "secondary-ipv4-addresses": {
            "secondary-ipv4-address": [
              {
                "ip-address": "string"
              }
            ]
          },
          "primary-ipv4-address": "string"
        }
      ]
    },
    "version2": {
      "virtual-routers": {
        "virtual-router": [
          {
            "tracked-objects": {
              "tracked-object": [
                {
                  "object-name": "string",
                  "priority-decrement": "integer"
                }
              ]
            },
            "session-name": "string",
            "bfd": "string",
            "tracks": {
              "track": [
                {
                  "priority": "integer",
                  "interface-name": "string"
                }
              ]
            },
            "timer": {
              "advertisement-time-in-msec": "integer",
              "forced": [ null ],
              "advertisement-time-in-sec": "integer"
            },
            "primary-ipv4-address": "string",
            "priority": "integer",
            "preempt": "integer",
            "secondary-ipv4-addresses": {
              "secondary-ipv4-address": [
                {
                  "ip-address": "string"
                }
              ]
            },
            "accept-mode-disable": [ null ],
            "vr-id": "integer",
            "text-password": "string"
          }
        ]
      }
    },
    "version3": {
      "virtual-routers": {
        "virtual-router": [
          {}
        ]
      }
    }
  }
}

ipv6_schema:

IPv6 VRRP configuration

slave-virtual-routers: object

The VRRP slave group configuration table

slave-virtual-router: object[]

The VRRP slave being configured

object
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

follow: string

VRRP Session name for this slave to follow

link-local-ipv6-address: object

The VRRP IPv6 virtual linklocal address

auto-configure: boolean

TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured

ip-address: string

VRRP IPv6 virtual linklocal address

slave-virtual-router-id: integer

Virtual Router ID

range:"1..255"
global-ipv6-addresses: object

The table of VRRP virtual global IPv6 addresses

global-ipv6-address: object[]

A VRRP virtual global IPv6 IP address

object
ip-address: string

VRRP virtual global IPv6 address

version3: object

Version 3 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
link-local-ipv6-address: object

The VRRP IPv6 virtual linklocal address

auto-configure: boolean

TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured

ip-address: string

VRRP IPv6 virtual linklocal address

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
global-ipv6-addresses: object

The table of VRRP virtual global IPv6 addresses

global-ipv6-address: object[]

A VRRP virtual global IPv6 IP address

object
ip-address: string

VRRP virtual global IPv6 address

priority: integer

Priority value

range:"1..254" default:"100"
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

session-name: string

VRRP Session Name

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
Example
{
  "slave-virtual-routers": {
    "slave-virtual-router": [
      {
        "accept-mode-disable": [ null ],
        "follow": "string",
        "link-local-ipv6-address": {
          "auto-configure": "boolean",
          "ip-address": "string"
        },
        "slave-virtual-router-id": "integer",
        "global-ipv6-addresses": {
          "global-ipv6-address": [
            {
              "ip-address": "string"
            }
          ]
        }
      }
    ]
  },
  "version3": {
    "virtual-routers": {
      "virtual-router": [
        {
          "link-local-ipv6-address": {
            "auto-configure": "boolean",
            "ip-address": "string"
          },
          "bfd": "string",
          "tracks": {
            "track": [
              {
                "priority": "integer",
                "interface-name": "string"
              }
            ]
          },
          "timer": {
            "advertisement-time-in-msec": "integer",
            "forced": [ null ],
            "advertisement-time-in-sec": "integer"
          },
          "global-ipv6-addresses": {
            "global-ipv6-address": [
              {
                "ip-address": "string"
              }
            ]
          },
          "priority": "integer",
          "tracked-objects": {
            "tracked-object": [
              {
                "object-name": "string",
                "priority-decrement": "integer"
              }
            ]
          },
          "accept-mode-disable": [ null ],
          "session-name": "string",
          "vr-id": "integer",
          "preempt": "integer"
        }
      ]
    }
  }
}

version3_schema:

Version 3 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

primary-ipv4-address: string

The Primary VRRP IPv4 address

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
priority: integer

Priority value

range:"1..254" default:"100"
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
Example
{
  "virtual-routers": {
    "virtual-router": [
      {
        "session-name": "string",
        "bfd": "string",
        "tracks": {
          "track": [
            {
              "priority": "integer",
              "interface-name": "string"
            }
          ]
        },
        "primary-ipv4-address": "string",
        "timer": {
          "advertisement-time-in-msec": "integer",
          "forced": [ null ],
          "advertisement-time-in-sec": "integer"
        },
        "priority": "integer",
        "tracked-objects": {
          "tracked-object": [
            {
              "object-name": "string",
              "priority-decrement": "integer"
            }
          ]
        },
        "secondary-ipv4-addresses": {
          "secondary-ipv4-address": [
            {
              "ip-address": "string"
            }
          ]
        },
        "accept-mode-disable": [ null ],
        "vr-id": "integer",
        "preempt": "integer"
      }
    ]
  }
}

virtual-routers_schema:

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
primary-ipv4-address: string

The Primary VRRP IPv4 address

priority: integer

Priority value

range:"1..254" default:"100"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
text-password: string

Authentication password, 8 chars max

Example
{
  "virtual-router": [
    {
      "tracked-objects": {
        "tracked-object": [
          {
            "object-name": "string",
            "priority-decrement": "integer"
          }
        ]
      },
      "session-name": "string",
      "bfd": "string",
      "tracks": {
        "track": [
          {
            "priority": "integer",
            "interface-name": "string"
          }
        ]
      },
      "timer": {
        "advertisement-time-in-msec": "integer",
        "forced": [ null ],
        "advertisement-time-in-sec": "integer"
      },
      "primary-ipv4-address": "string",
      "priority": "integer",
      "preempt": "integer",
      "secondary-ipv4-addresses": {
        "secondary-ipv4-address": [
          {
            "ip-address": "string"
          }
        ]
      },
      "accept-mode-disable": [ null ],
      "vr-id": "integer",
      "text-password": "string"
    }
  ]
}

virtual-router_schema:

tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
primary-ipv4-address: string

The Primary VRRP IPv4 address

priority: integer

Priority value

range:"1..254" default:"100"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
text-password: string

Authentication password, 8 chars max

Example
{
  "tracked-objects": {
    "tracked-object": [
      {
        "object-name": "string",
        "priority-decrement": "integer"
      }
    ]
  },
  "session-name": "string",
  "bfd": "string",
  "tracks": {
    "track": [
      {
        "priority": "integer",
        "interface-name": "string"
      }
    ]
  },
  "timer": {
    "advertisement-time-in-msec": "integer",
    "forced": [ null ],
    "advertisement-time-in-sec": "integer"
  },
  "primary-ipv4-address": "string",
  "priority": "integer",
  "preempt": "integer",
  "secondary-ipv4-addresses": {
    "secondary-ipv4-address": [
      {
        "ip-address": "string"
      }
    ]
  },
  "accept-mode-disable": [ null ],
  "vr-id": "integer",
  "text-password": "string"
}

global-ipv6-addresses_schema:

The table of VRRP virtual global IPv6 addresses

global-ipv6-address: object[]

A VRRP virtual global IPv6 IP address

object
ip-address: string

VRRP virtual global IPv6 address

Example
{
  "global-ipv6-address": [
    {
      "ip-address": "string"
    }
  ]
}

global-ipv6-address_schema:

ip-address: string

VRRP virtual global IPv6 address

Example
{
  "ip-address": "string"
}

tracks_schema:

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

Example
{
  "track": [
    {
      "priority": "integer",
      "interface-name": "string"
    }
  ]
}

track_schema:

priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

Example
{
  "priority": "integer",
  "interface-name": "string"
}

timer_schema:

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
Example
{
  "advertisement-time-in-msec": "integer",
  "forced": [ null ],
  "advertisement-time-in-sec": "integer"
}

tracked-objects_schema:

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
Example
{
  "tracked-object": [
    {
      "object-name": "string",
      "priority-decrement": "integer"
    }
  ]
}

tracked-object_schema:

object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
Example
{
  "object-name": "string",
  "priority-decrement": "integer"
}

slave-virtual-routers_schema:

The VRRP slave group configuration table

slave-virtual-router: object[]

The VRRP slave being configured

object
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

follow: string

VRRP Session name for this slave to follow

slave-virtual-router-id: integer

Virtual Router ID

range:"1..255"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

primary-ipv4-address: string

The Primary VRRP IPv4 address

Example
{
  "slave-virtual-router": [
    {
      "accept-mode-disable": [ null ],
      "follow": "string",
      "slave-virtual-router-id": "integer",
      "secondary-ipv4-addresses": {
        "secondary-ipv4-address": [
          {
            "ip-address": "string"
          }
        ]
      },
      "primary-ipv4-address": "string"
    }
  ]
}

slave-virtual-router_schema:

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

follow: string

VRRP Session name for this slave to follow

slave-virtual-router-id: integer

Virtual Router ID

range:"1..255"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

primary-ipv4-address: string

The Primary VRRP IPv4 address

Example
{
  "accept-mode-disable": [ null ],
  "follow": "string",
  "slave-virtual-router-id": "integer",
  "secondary-ipv4-addresses": {
    "secondary-ipv4-address": [
      {
        "ip-address": "string"
      }
    ]
  },
  "primary-ipv4-address": "string"
}

delay_schema:

Minimum and Reload Delay

reload-delay: integer

Reload delay in seconds

range:"0..10000" units:"second"
min-delay: integer

Minimum delay in seconds

range:"0..10000" units:"second"
Example
{
  "reload-delay": "integer",
  "min-delay": "integer"
}

ipv4_schema:

IPv4 VRRP configuration

slave-virtual-routers: object

The VRRP slave group configuration table

slave-virtual-router: object[]

The VRRP slave being configured

object
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

follow: string

VRRP Session name for this slave to follow

slave-virtual-router-id: integer

Virtual Router ID

range:"1..255"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

primary-ipv4-address: string

The Primary VRRP IPv4 address

version2: object

Version 2 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
primary-ipv4-address: string

The Primary VRRP IPv4 address

priority: integer

Priority value

range:"1..254" default:"100"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
text-password: string

Authentication password, 8 chars max

version3: object

Version 3 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

primary-ipv4-address: string

The Primary VRRP IPv4 address

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
priority: integer

Priority value

range:"1..254" default:"100"
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
Example
{
  "slave-virtual-routers": {
    "slave-virtual-router": [
      {
        "accept-mode-disable": [ null ],
        "follow": "string",
        "slave-virtual-router-id": "integer",
        "secondary-ipv4-addresses": {
          "secondary-ipv4-address": [
            {
              "ip-address": "string"
            }
          ]
        },
        "primary-ipv4-address": "string"
      }
    ]
  },
  "version2": {
    "virtual-routers": {
      "virtual-router": [
        {
          "tracked-objects": {
            "tracked-object": [
              {
                "object-name": "string",
                "priority-decrement": "integer"
              }
            ]
          },
          "session-name": "string",
          "bfd": "string",
          "tracks": {
            "track": [
              {
                "priority": "integer",
                "interface-name": "string"
              }
            ]
          },
          "timer": {
            "advertisement-time-in-msec": "integer",
            "forced": [ null ],
            "advertisement-time-in-sec": "integer"
          },
          "primary-ipv4-address": "string",
          "priority": "integer",
          "preempt": "integer",
          "secondary-ipv4-addresses": {
            "secondary-ipv4-address": [
              {
                "ip-address": "string"
              }
            ]
          },
          "accept-mode-disable": [ null ],
          "vr-id": "integer",
          "text-password": "string"
        }
      ]
    }
  },
  "version3": {
    "virtual-routers": {
      "virtual-router": [
        {
          "session-name": "string",
          "bfd": "string",
          "tracks": {
            "track": [
              {
                "priority": "integer",
                "interface-name": "string"
              }
            ]
          },
          "primary-ipv4-address": "string",
          "timer": {
            "advertisement-time-in-msec": "integer",
            "forced": [ null ],
            "advertisement-time-in-sec": "integer"
          },
          "priority": "integer",
          "tracked-objects": {
            "tracked-object": [
              {
                "object-name": "string",
                "priority-decrement": "integer"
              }
            ]
          },
          "secondary-ipv4-addresses": {
            "secondary-ipv4-address": [
              {
                "ip-address": "string"
              }
            ]
          },
          "accept-mode-disable": [ null ],
          "vr-id": "integer",
          "preempt": "integer"
        }
      ]
    }
  }
}

secondary-ipv4-addresses_schema:

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

Example
{
  "secondary-ipv4-address": [
    {
      "ip-address": "string"
    }
  ]
}

secondary-ipv4-address_schema:

ip-address: string

VRRP Secondary IPv4 address

Example
{
  "ip-address": "string"
}

version2_schema:

Version 2 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
primary-ipv4-address: string

The Primary VRRP IPv4 address

priority: integer

Priority value

range:"1..254" default:"100"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
text-password: string

Authentication password, 8 chars max

Example
{
  "virtual-routers": {
    "virtual-router": [
      {
        "tracked-objects": {
          "tracked-object": [
            {
              "object-name": "string",
              "priority-decrement": "integer"
            }
          ]
        },
        "session-name": "string",
        "bfd": "string",
        "tracks": {
          "track": [
            {
              "priority": "integer",
              "interface-name": "string"
            }
          ]
        },
        "timer": {
          "advertisement-time-in-msec": "integer",
          "forced": [ null ],
          "advertisement-time-in-sec": "integer"
        },
        "primary-ipv4-address": "string",
        "priority": "integer",
        "preempt": "integer",
        "secondary-ipv4-addresses": {
          "secondary-ipv4-address": [
            {
              "ip-address": "string"
            }
          ]
        },
        "accept-mode-disable": [ null ],
        "vr-id": "integer",
        "text-password": "string"
      }
    ]
  }
}

bfd_schema:

BFD configuration

interval: integer

Hello interval for BFD sessions created by vrrp

units:"millisecond"
detection-multiplier: integer

Detection multiplier for BFD sessions created by vrrp

range:"2..50"
Example
{
  "interval": "integer",
  "detection-multiplier": "integer"
}

a1_vrrp_schema:

VRRP-MIB notification configuration

enable: null

Enable VRRP-MIB notifications

Example
{
  "enable": [ null ]
}

a1_logging_schema:

SNMP logging

threshold: object

SNMP logging threshold

oid-processing: integer

SNMP logging threshold for OID processing

range:"0..20000" default:"500"
pdu-processing: integer

SNMP logging threshold for PDU processing

range:"0..20000" default:"20000"
Example
{
  "threshold": {
    "oid-processing": "integer",
    "pdu-processing": "integer"
  }
}

a1_interfaces_schema:

Interface configuration table

interface: object[]

The interface being configured

object
mac-refresh: integer

VRRP Slave MAC-refresh rate in seconds

range:"0..10000" units:"second" default:"60"
delay: object

Minimum and Reload Delay

reload-delay: integer

Reload delay in seconds

range:"0..10000" units:"second"
min-delay: integer

Minimum delay in seconds

range:"0..10000" units:"second"
interface-name: string

Interface name to configure

bfd: object

BFD configuration

interval: integer

Hello interval for BFD sessions created by vrrp

units:"millisecond"
detection-multiplier: integer

Detection multiplier for BFD sessions created by vrrp

range:"2..50"
ipv6: object

IPv6 VRRP configuration

slave-virtual-routers: object

The VRRP slave group configuration table

slave-virtual-router: object[]

The VRRP slave being configured

object
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

follow: string

VRRP Session name for this slave to follow

link-local-ipv6-address: object

The VRRP IPv6 virtual linklocal address

auto-configure: boolean

TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured

ip-address: string

VRRP IPv6 virtual linklocal address

slave-virtual-router-id: integer

Virtual Router ID

range:"1..255"
global-ipv6-addresses: object

The table of VRRP virtual global IPv6 addresses

global-ipv6-address: object[]

A VRRP virtual global IPv6 IP address

object
ip-address: string

VRRP virtual global IPv6 address

version3: object

Version 3 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
link-local-ipv6-address: object

The VRRP IPv6 virtual linklocal address

auto-configure: boolean

TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured

ip-address: string

VRRP IPv6 virtual linklocal address

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
global-ipv6-addresses: object

The table of VRRP virtual global IPv6 addresses

global-ipv6-address: object[]

A VRRP virtual global IPv6 IP address

object
ip-address: string

VRRP virtual global IPv6 address

priority: integer

Priority value

range:"1..254" default:"100"
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

session-name: string

VRRP Session Name

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
ipv4: object

IPv4 VRRP configuration

slave-virtual-routers: object

The VRRP slave group configuration table

slave-virtual-router: object[]

The VRRP slave being configured

object
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

follow: string

VRRP Session name for this slave to follow

slave-virtual-router-id: integer

Virtual Router ID

range:"1..255"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

primary-ipv4-address: string

The Primary VRRP IPv4 address

version2: object

Version 2 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
primary-ipv4-address: string

The Primary VRRP IPv4 address

priority: integer

Priority value

range:"1..254" default:"100"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
text-password: string

Authentication password, 8 chars max

version3: object

Version 3 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

primary-ipv4-address: string

The Primary VRRP IPv4 address

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
priority: integer

Priority value

range:"1..254" default:"100"
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
Example
{
  "interface": [
    {
      "mac-refresh": "integer",
      "delay": {
        "reload-delay": "integer",
        "min-delay": "integer"
      },
      "interface-name": "string",
      "bfd": {
        "interval": "integer",
        "detection-multiplier": "integer"
      },
      "ipv6": {
        "slave-virtual-routers": {
          "slave-virtual-router": [
            {
              "accept-mode-disable": [ null ],
              "follow": "string",
              "link-local-ipv6-address": {
                "auto-configure": "boolean",
                "ip-address": "string"
              },
              "slave-virtual-router-id": "integer",
              "global-ipv6-addresses": {
                "global-ipv6-address": [
                  {
                    "ip-address": "string"
                  }
                ]
              }
            }
          ]
        },
        "version3": {
          "virtual-routers": {
            "virtual-router": [
              {
                "link-local-ipv6-address": {
                  "auto-configure": "boolean",
                  "ip-address": "string"
                },
                "bfd": "string",
                "tracks": {
                  "track": [
                    {
                      "priority": "integer",
                      "interface-name": "string"
                    }
                  ]
                },
                "timer": {
                  "advertisement-time-in-msec": "integer",
                  "forced": [ null ],
                  "advertisement-time-in-sec": "integer"
                },
                "global-ipv6-addresses": {
                  "global-ipv6-address": [
                    {
                      "ip-address": "string"
                    }
                  ]
                },
                "priority": "integer",
                "tracked-objects": {
                  "tracked-object": [
                    {
                      "object-name": "string",
                      "priority-decrement": "integer"
                    }
                  ]
                },
                "accept-mode-disable": [ null ],
                "session-name": "string",
                "vr-id": "integer",
                "preempt": "integer"
              }
            ]
          }
        }
      },
      "ipv4": {
        "slave-virtual-routers": {
          "slave-virtual-router": [
            {
              "accept-mode-disable": [ null ],
              "follow": "string",
              "slave-virtual-router-id": "integer",
              "secondary-ipv4-addresses": {
                "secondary-ipv4-address": [
                  {
                    "ip-address": "string"
                  }
                ]
              },
              "primary-ipv4-address": "string"
            }
          ]
        },
        "version2": {
          "virtual-routers": {
            "virtual-router": [
              {
                "tracked-objects": {
                  "tracked-object": [
                    {
                      "object-name": "string",
                      "priority-decrement": "integer"
                    }
                  ]
                },
                "session-name": "string",
                "bfd": "string",
                "tracks": {
                  "track": [
                    {
                      "priority": "integer",
                      "interface-name": "string"
                    }
                  ]
                },
                "timer": {
                  "advertisement-time-in-msec": "integer",
                  "forced": [ null ],
                  "advertisement-time-in-sec": "integer"
                },
                "primary-ipv4-address": "string",
                "priority": "integer",
                "preempt": "integer",
                "secondary-ipv4-addresses": {
                  "secondary-ipv4-address": [
                    {
                      "ip-address": "string"
                    }
                  ]
                },
                "accept-mode-disable": [ null ],
                "vr-id": "integer",
                "text-password": "string"
              }
            ]
          }
        },
        "version3": {
          "virtual-routers": {}
        }
      }
    }
  ]
}

a1_interface_schema:

mac-refresh: integer

VRRP Slave MAC-refresh rate in seconds

range:"0..10000" units:"second" default:"60"
delay: object

Minimum and Reload Delay

reload-delay: integer

Reload delay in seconds

range:"0..10000" units:"second"
min-delay: integer

Minimum delay in seconds

range:"0..10000" units:"second"
interface-name: string

Interface name to configure

bfd: object

BFD configuration

interval: integer

Hello interval for BFD sessions created by vrrp

units:"millisecond"
detection-multiplier: integer

Detection multiplier for BFD sessions created by vrrp

range:"2..50"
ipv6: object

IPv6 VRRP configuration

slave-virtual-routers: object

The VRRP slave group configuration table

slave-virtual-router: object[]

The VRRP slave being configured

object
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

follow: string

VRRP Session name for this slave to follow

link-local-ipv6-address: object

The VRRP IPv6 virtual linklocal address

auto-configure: boolean

TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured

ip-address: string

VRRP IPv6 virtual linklocal address

slave-virtual-router-id: integer

Virtual Router ID

range:"1..255"
global-ipv6-addresses: object

The table of VRRP virtual global IPv6 addresses

global-ipv6-address: object[]

A VRRP virtual global IPv6 IP address

object
ip-address: string

VRRP virtual global IPv6 address

version3: object

Version 3 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
link-local-ipv6-address: object

The VRRP IPv6 virtual linklocal address

auto-configure: boolean

TRUE if the virtual linklocal address is to be autoconfigured FALSE if an IPv6 virtual linklocal address is configured

ip-address: string

VRRP IPv6 virtual linklocal address

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
global-ipv6-addresses: object

The table of VRRP virtual global IPv6 addresses

global-ipv6-address: object[]

A VRRP virtual global IPv6 IP address

object
ip-address: string

VRRP virtual global IPv6 address

priority: integer

Priority value

range:"1..254" default:"100"
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

session-name: string

VRRP Session Name

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
ipv4: object

IPv4 VRRP configuration

slave-virtual-routers: object

The VRRP slave group configuration table

slave-virtual-router: object[]

The VRRP slave being configured

object
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

follow: string

VRRP Session name for this slave to follow

slave-virtual-router-id: integer

Virtual Router ID

range:"1..255"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

primary-ipv4-address: string

The Primary VRRP IPv4 address

version2: object

Version 2 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
primary-ipv4-address: string

The Primary VRRP IPv4 address

priority: integer

Priority value

range:"1..254" default:"100"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
text-password: string

Authentication password, 8 chars max

version3: object

Version 3 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

primary-ipv4-address: string

The Primary VRRP IPv4 address

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
priority: integer

Priority value

range:"1..254" default:"100"
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
Example
{
  "mac-refresh": "integer",
  "delay": {
    "reload-delay": "integer",
    "min-delay": "integer"
  },
  "interface-name": "string",
  "bfd": {
    "interval": "integer",
    "detection-multiplier": "integer"
  },
  "ipv6": {
    "slave-virtual-routers": {
      "slave-virtual-router": [
        {
          "accept-mode-disable": [ null ],
          "follow": "string",
          "link-local-ipv6-address": {
            "auto-configure": "boolean",
            "ip-address": "string"
          },
          "slave-virtual-router-id": "integer",
          "global-ipv6-addresses": {
            "global-ipv6-address": [
              {
                "ip-address": "string"
              }
            ]
          }
        }
      ]
    },
    "version3": {
      "virtual-routers": {
        "virtual-router": [
          {
            "link-local-ipv6-address": {
              "auto-configure": "boolean",
              "ip-address": "string"
            },
            "bfd": "string",
            "tracks": {
              "track": [
                {
                  "priority": "integer",
                  "interface-name": "string"
                }
              ]
            },
            "timer": {
              "advertisement-time-in-msec": "integer",
              "forced": [ null ],
              "advertisement-time-in-sec": "integer"
            },
            "global-ipv6-addresses": {
              "global-ipv6-address": [
                {
                  "ip-address": "string"
                }
              ]
            },
            "priority": "integer",
            "tracked-objects": {
              "tracked-object": [
                {
                  "object-name": "string",
                  "priority-decrement": "integer"
                }
              ]
            },
            "accept-mode-disable": [ null ],
            "session-name": "string",
            "vr-id": "integer",
            "preempt": "integer"
          }
        ]
      }
    }
  },
  "ipv4": {
    "slave-virtual-routers": {
      "slave-virtual-router": [
        {
          "accept-mode-disable": [ null ],
          "follow": "string",
          "slave-virtual-router-id": "integer",
          "secondary-ipv4-addresses": {
            "secondary-ipv4-address": [
              {
                "ip-address": "string"
              }
            ]
          },
          "primary-ipv4-address": "string"
        }
      ]
    },
    "version2": {
      "virtual-routers": {
        "virtual-router": [
          {
            "tracked-objects": {
              "tracked-object": [
                {
                  "object-name": "string",
                  "priority-decrement": "integer"
                }
              ]
            },
            "session-name": "string",
            "bfd": "string",
            "tracks": {
              "track": [
                {
                  "priority": "integer",
                  "interface-name": "string"
                }
              ]
            },
            "timer": {
              "advertisement-time-in-msec": "integer",
              "forced": [ null ],
              "advertisement-time-in-sec": "integer"
            },
            "primary-ipv4-address": "string",
            "priority": "integer",
            "preempt": "integer",
            "secondary-ipv4-addresses": {
              "secondary-ipv4-address": [
                {
                  "ip-address": "string"
                }
              ]
            },
            "accept-mode-disable": [ null ],
            "vr-id": "integer",
            "text-password": "string"
          }
        ]
      }
    },
    "version3": {
      "virtual-routers": {
        "virtual-router": [
          {}
        ]
      }
    }
  }
}

a1_ipv6_schema:

SNMP TOS bit for outgoing packets

tos: object

Type of TOS

type: string precedence, dscp

SNMP TOS type DSCP or Precedence

dscp: string

SNMP DSCP value

precedence: string

SNMP Precedence value

Example
{
  "tos": {
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

a1_version3_schema:

Version 3 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

primary-ipv4-address: string

The Primary VRRP IPv4 address

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
priority: integer

Priority value

range:"1..254" default:"100"
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
Example
{
  "virtual-routers": {
    "virtual-router": [
      {
        "session-name": "string",
        "bfd": "string",
        "tracks": {
          "track": [
            {
              "priority": "integer",
              "interface-name": "string"
            }
          ]
        },
        "primary-ipv4-address": "string",
        "timer": {
          "advertisement-time-in-msec": "integer",
          "forced": [ null ],
          "advertisement-time-in-sec": "integer"
        },
        "priority": "integer",
        "tracked-objects": {
          "tracked-object": [
            {
              "object-name": "string",
              "priority-decrement": "integer"
            }
          ]
        },
        "secondary-ipv4-addresses": {
          "secondary-ipv4-address": [
            {
              "ip-address": "string"
            }
          ]
        },
        "accept-mode-disable": [ null ],
        "vr-id": "integer",
        "preempt": "integer"
      }
    ]
  }
}

a1_virtual-routers_schema:

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
primary-ipv4-address: string

The Primary VRRP IPv4 address

priority: integer

Priority value

range:"1..254" default:"100"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
text-password: string

Authentication password, 8 chars max

Example
{
  "virtual-router": [
    {
      "tracked-objects": {
        "tracked-object": [
          {
            "object-name": "string",
            "priority-decrement": "integer"
          }
        ]
      },
      "session-name": "string",
      "bfd": "string",
      "tracks": {
        "track": [
          {
            "priority": "integer",
            "interface-name": "string"
          }
        ]
      },
      "timer": {
        "advertisement-time-in-msec": "integer",
        "forced": [ null ],
        "advertisement-time-in-sec": "integer"
      },
      "primary-ipv4-address": "string",
      "priority": "integer",
      "preempt": "integer",
      "secondary-ipv4-addresses": {
        "secondary-ipv4-address": [
          {
            "ip-address": "string"
          }
        ]
      },
      "accept-mode-disable": [ null ],
      "vr-id": "integer",
      "text-password": "string"
    }
  ]
}

a1_virtual-router_schema:

tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
primary-ipv4-address: string

The Primary VRRP IPv4 address

priority: integer

Priority value

range:"1..254" default:"100"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
text-password: string

Authentication password, 8 chars max

Example
{
  "tracked-objects": {
    "tracked-object": [
      {
        "object-name": "string",
        "priority-decrement": "integer"
      }
    ]
  },
  "session-name": "string",
  "bfd": "string",
  "tracks": {
    "track": [
      {
        "priority": "integer",
        "interface-name": "string"
      }
    ]
  },
  "timer": {
    "advertisement-time-in-msec": "integer",
    "forced": [ null ],
    "advertisement-time-in-sec": "integer"
  },
  "primary-ipv4-address": "string",
  "priority": "integer",
  "preempt": "integer",
  "secondary-ipv4-addresses": {
    "secondary-ipv4-address": [
      {
        "ip-address": "string"
      }
    ]
  },
  "accept-mode-disable": [ null ],
  "vr-id": "integer",
  "text-password": "string"
}

a1_global-ipv6-addresses_schema:

The table of VRRP virtual global IPv6 addresses

global-ipv6-address: object[]

A VRRP virtual global IPv6 IP address

object
ip-address: string

VRRP virtual global IPv6 address

Example
{
  "global-ipv6-address": [
    {
      "ip-address": "string"
    }
  ]
}

a1_global-ipv6-address_schema:

ip-address: string

VRRP virtual global IPv6 address

Example
{
  "ip-address": "string"
}

a1_tracks_schema:

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

Example
{
  "track": [
    {
      "priority": "integer",
      "interface-name": "string"
    }
  ]
}

a1_track_schema:

priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

Example
{
  "priority": "integer",
  "interface-name": "string"
}

a1_timer_schema:

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
Example
{
  "advertisement-time-in-msec": "integer",
  "forced": [ null ],
  "advertisement-time-in-sec": "integer"
}

a1_tracked-objects_schema:

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
Example
{
  "tracked-object": [
    {
      "object-name": "string",
      "priority-decrement": "integer"
    }
  ]
}

a1_tracked-object_schema:

object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
Example
{
  "object-name": "string",
  "priority-decrement": "integer"
}

a1_slave-virtual-routers_schema:

The VRRP slave group configuration table

slave-virtual-router: object[]

The VRRP slave being configured

object
accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

follow: string

VRRP Session name for this slave to follow

slave-virtual-router-id: integer

Virtual Router ID

range:"1..255"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

primary-ipv4-address: string

The Primary VRRP IPv4 address

Example
{
  "slave-virtual-router": [
    {
      "accept-mode-disable": [ null ],
      "follow": "string",
      "slave-virtual-router-id": "integer",
      "secondary-ipv4-addresses": {
        "secondary-ipv4-address": [
          {
            "ip-address": "string"
          }
        ]
      },
      "primary-ipv4-address": "string"
    }
  ]
}

a1_slave-virtual-router_schema:

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

follow: string

VRRP Session name for this slave to follow

slave-virtual-router-id: integer

Virtual Router ID

range:"1..255"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

primary-ipv4-address: string

The Primary VRRP IPv4 address

Example
{
  "accept-mode-disable": [ null ],
  "follow": "string",
  "slave-virtual-router-id": "integer",
  "secondary-ipv4-addresses": {
    "secondary-ipv4-address": [
      {
        "ip-address": "string"
      }
    ]
  },
  "primary-ipv4-address": "string"
}

a1_delay_schema:

Minimum and Reload Delay

reload-delay: integer

Reload delay in seconds

range:"0..10000" units:"second"
min-delay: integer

Minimum delay in seconds

range:"0..10000" units:"second"
Example
{
  "reload-delay": "integer",
  "min-delay": "integer"
}

a1_ipv4_schema:

SNMP TOS bit for outgoing packets

tos: object

Type of TOS

type: string precedence, dscp

SNMP TOS type DSCP or Precedence

dscp: string

SNMP DSCP value

precedence: string

SNMP Precedence value

Example
{
  "tos": {
    "type": "string",
    "dscp": "string",
    "precedence": "string"
  }
}

a1_secondary-ipv4-addresses_schema:

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

Example
{
  "secondary-ipv4-address": [
    {
      "ip-address": "string"
    }
  ]
}

a1_secondary-ipv4-address_schema:

ip-address: string

VRRP Secondary IPv4 address

Example
{
  "ip-address": "string"
}

a1_version2_schema:

Version 2 VRRP configuration

virtual-routers: object

The VRRP virtual router configuration table

virtual-router: object[]

The VRRP virtual router being configured

object
tracked-objects: object

Track an object, reducing priority if it goes down

tracked-object: object[]

Object to be tracked

object
object-name: string

Object to be tracked, interface name for interfaces

priority-decrement: integer

Priority decrement

range:"1..254"
session-name: string

VRRP Session Name

bfd: string

Enable use of Bidirectional Forwarding Detection for this IP

tracks: object

Track an item, reducing priority if it goes down

track: object[]

Object to be tracked

object
priority: integer

Priority decrement

range:"1..254" default:"100"
interface-name: string

Object to be tracked, interface name for interfaces

timer: object

Set advertisement timer

advertisement-time-in-msec: integer

Advertisement time in milliseconds

range:"100..40950" units:"millisecond"
forced: null

TRUE - Force configured timer values to be used, required when configured in milliseconds

advertisement-time-in-sec: integer

Advertisement time in seconds

range:"1..255" units:"second"
primary-ipv4-address: string

The Primary VRRP IPv4 address

priority: integer

Priority value

range:"1..254" default:"100"
preempt: integer

Preempt Master router if higher priority

range:"0..3600" default:"0"
secondary-ipv4-addresses: object

The table of VRRP secondary IPv4 addresses

secondary-ipv4-address: object[]

A VRRP secondary IPv4 address

object
ip-address: string

VRRP Secondary IPv4 address

accept-mode-disable: null

Disable Accept Mode for this virtual IPAddress

vr-id: integer

VRID Virtual Router Identifier

range:"1..255"
text-password: string

Authentication password, 8 chars max

Example
{
  "virtual-routers": {
    "virtual-router": [
      {
        "tracked-objects": {
          "tracked-object": [
            {
              "object-name": "string",
              "priority-decrement": "integer"
            }
          ]
        },
        "session-name": "string",
        "bfd": "string",
        "tracks": {
          "track": [
            {
              "priority": "integer",
              "interface-name": "string"
            }
          ]
        },
        "timer": {
          "advertisement-time-in-msec": "integer",
          "forced": [ null ],
          "advertisement-time-in-sec": "integer"
        },
        "primary-ipv4-address": "string",
        "priority": "integer",
        "preempt": "integer",
        "secondary-ipv4-addresses": {
          "secondary-ipv4-address": [
            {
              "ip-address": "string"
            }
          ]
        },
        "accept-mode-disable": [ null ],
        "vr-id": "integer",
        "text-password": "string"
      }
    ]
  }
}

a1_bfd_schema:

BFD configuration

interval: integer

Hello interval for BFD sessions created by vrrp

units:"millisecond"
detection-multiplier: integer

Detection multiplier for BFD sessions created by vrrp

range:"2..50"
Example
{
  "interval": "integer",
  "detection-multiplier": "integer"
}

TRAP-HOST-TABLE:

Common node of snmp, vrf

trap-hosts: object

Specify hosts to receive SNMP notifications

trap-host: object[]

Specify hosts to receive SNMP notifications

object
encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-host: object

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

ip-address: string

IP address of SNMP notification host

default-user-communities: object

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "trap-hosts": {
    "trap-host": [
      {
        "encrypted-user-communities": {
          "encrypted-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        "inform-host": {
          "inform-encrypted-user-communities": {
            "inform-encrypted-user-community": [
              {
                "port": "string",
                "version": "string",
                "community-name": "string",
                "basic-trap-types": "integer",
                "advanced-trap-types2": "integer",
                "security-level": "string",
                "advanced-trap-types1": "integer"
              }
            ]
          },
          "inform-user-communities": {
            "inform-user-community": [
              {
                "port": "string",
                "version": "string",
                "community-name": "string",
                "basic-trap-types": "integer",
                "advanced-trap-types2": "integer",
                "security-level": "string",
                "advanced-trap-types1": "integer"
              }
            ]
          }
        },
        "ip-address": "string",
        "default-user-communities": {
          "default-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      }
    ]
  }
}

APPLIED-TO:

Common node of rule, rule-set

applied-to: object

Applied to the Rule or Ruleset

all: null

Apply to all of the device

hosts: object

Table of configured hosts to apply rules to

host: object[]

A destination host

object
port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

CONTEXT-MAPPING-TABLE:

Common node of snmp, vrf

context-mappings: object

List of context names

context-mapping: object[]

Context mapping name

object
context-mapping-name: string

Context mapping name

vrf-name: string

VRF name associated with the context

topology-name: string

Topology name associated with the context

context: string vrf, bridge, ospf, ospfv3

SNMP context feature type

instance-name: string

OSPF protocol instance

Example
{
  "context-mappings": {
    "context-mapping": [
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

VAR-BIND-TABLE:

Common node of root-cause, non-root-cause

var-binds: object

Varbinds to match

var-bind: object[]

Varbind match conditions

object
oid: string

OID of varbind (dotted decimal)

match: object

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

CONTEXT-TABLE:

Common node of snmp, vrf

contexts: object

List of Context Names

context: object[]

Context Name

object
context-name: string

Context Name

Example
{
  "contexts": {
    "context": [
      {
        "context-name": "string"
      }
    ]
  }
}

a1_snmp_schema:

SNMP notification configuration

authentication: null

Enable authentication notification

enable: null

Enable SNMP notifications

warm-start: null

Enable warm start notification

cold-start: null

Enable cold start notification

Example
{
  "authentication": [ null ],
  "enable": [ null ],
  "warm-start": [ null ],
  "cold-start": [ null ]
}

a1_encrypted-community-maps_schema:

Container class to hold clear/encrypted communitie maps

encrypted-community-map: object[]

Clear/encrypted SNMP community map

object
security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "encrypted-community-map": [
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

a1_encrypted-community-map_schema:

security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

a1_views_schema:

Class to configure a SNMPv2 MIB view

view: object[]

Name of the view

object
view-name: string

Name of the view

view-inclusion: string included, excluded

MIB view to be included or excluded

family: string

MIB view family name

Example
{
  "view": [
    {
      "view-name": "string",
      "view-inclusion": "string",
      "family": "string"
    }
  ]
}

a1_view_schema:

view-name: string

Name of the view

view-inclusion: string included, excluded

MIB view to be included or excluded

family: string

MIB view family name

Example
{
  "view-name": "string",
  "view-inclusion": "string",
  "family": "string"
}

a1_threshold_schema:

SNMP logging threshold

oid-processing: integer

SNMP logging threshold for OID processing

range:"0..20000" default:"500"
pdu-processing: integer

SNMP logging threshold for PDU processing

range:"0..20000" default:"20000"
Example
{
  "oid-processing": "integer",
  "pdu-processing": "integer"
}

a1_administration_schema:

Container class for SNMP administration

default-communities: object

Container class to hold unencrpted communities

default-community: object[]

Unencrpted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

encrypted-communities: object

Container class to hold clear/encrypted communities

encrypted-community: object[]

Clear/encrypted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "default-communities": {
    "default-community": [
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  },
  "encrypted-communities": {
    "encrypted-community": [
      {
        "priviledge": "string",
        "view-name": "string",
        "v6acl-type": "string",
        "v6-access-list": "string",
        "community-name": "string",
        "owner": "string",
        "v4acl-type": "string",
        "v4-access-list": "string"
      }
    ]
  }
}

a1_default-communities_schema:

Container class to hold unencrpted communities

default-community: object[]

Unencrpted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "default-community": [
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

a1_default-community_schema:

priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

a1_encrypted-communities_schema:

Container class to hold clear/encrypted communities

encrypted-community: object[]

Clear/encrypted SNMP community string and access priviledges

object
priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "encrypted-community": [
    {
      "priviledge": "string",
      "view-name": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "community-name": "string",
      "owner": "string",
      "v4acl-type": "string",
      "v4-access-list": "string"
    }
  ]
}

a1_encrypted-community_schema:

priviledge: string read-only, read-write

Read/Write Access

view-name: string

MIB view to which the community has access

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

community-name: string

SNMP community string

owner: string sdr-owner, system-owner

Logical Router or System owner access

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

Example
{
  "priviledge": "string",
  "view-name": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "community-name": "string",
  "owner": "string",
  "v4acl-type": "string",
  "v4-access-list": "string"
}

a1_agent_schema:

The heirarchy point for SNMP Agent configurations

engine-id: object

SNMPv3 engineID

remotes: object

SNMPv3 remote SNMP Entity

remote: object[]

engineID of the remote agent

object
remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

local: string

engineID of the local agent

Example
{
  "engine-id": {
    "remotes": {
      "remote": [
        {
          "remote-engine-id": "string",
          "remote-address": "string",
          "port": "string"
        }
      ]
    },
    "local": "string"
  }
}

a1_engine-id_schema:

SNMPv3 engineID

remotes: object

SNMPv3 remote SNMP Entity

remote: object[]

engineID of the remote agent

object
remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

local: string

engineID of the local agent

Example
{
  "remotes": {
    "remote": [
      {
        "remote-engine-id": "string",
        "remote-address": "string",
        "port": "string"
      }
    ]
  },
  "local": "string"
}

a1_remotes_schema:

SNMPv3 remote SNMP Entity

remote: object[]

engineID of the remote agent

object
remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

Example
{
  "remote": [
    {
      "remote-engine-id": "string",
      "remote-address": "string",
      "port": "string"
    }
  ]
}

a1_remote_schema:

remote-engine-id: string

engine ID octet string

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

Example
{
  "remote-engine-id": "string",
  "remote-address": "string",
  "port": "string"
}

a1_trap_schema:

Class to hold trap configurations

queue-length: integer

Message queue length for each TRAP host

range:"1..5000"
throttle-time: integer

Set throttle time for handling traps

range:"50..1000" units:"millisecond"
timeout: integer

Timeout for TRAP message retransmissions

range:"1..600000" units:"millisecond"
Example
{
  "queue-length": "integer",
  "throttle-time": "integer",
  "timeout": "integer"
}

a1_drop-packet_schema:

SNMP packet drop config

unknown-user: null

Enable drop unknown user name

Example
{
  "unknown-user": [ null ]
}

a1_tos_schema:

Type of TOS

type: string precedence, dscp

SNMP TOS type DSCP or Precedence

dscp: string

SNMP DSCP value

precedence: string

SNMP Precedence value

Example
{
  "type": "string",
  "dscp": "string",
  "precedence": "string"
}

a1_system_schema:

container to hold system information

chassis-id: string

String to uniquely identify this chassis

contact: string

identification of the contact person for this managed node

location: string

The physical location of this node

Example
{
  "chassis-id": "string",
  "contact": "string",
  "location": "string"
}

a1_target_schema:

target-addresses: object

SNMP Target address configurations

target-address: object[]

IP Address to be configured for the Target

object
ip-address: string

IPv4/Ipv6 address

target-list-name: string

Name of the target list

vrf-names: object

List of VRF Name for a target list

vrf-name: object[]

VRF name of the target

object
name: string

VRF Name

Example
{
  "target-addresses": {
    "target-address": [
      {
        "ip-address": "string"
      }
    ]
  },
  "target-list-name": "string",
  "vrf-names": {
    "vrf-name": [
      {
        "name": "string"
      }
    ]
  }
}

a1_targets_schema:

List of targets

target: object[]

Name of the target list

object
target-addresses: object

SNMP Target address configurations

target-address: object[]

IP Address to be configured for the Target

object
ip-address: string

IPv4/Ipv6 address

target-list-name: string

Name of the target list

vrf-names: object

List of VRF Name for a target list

vrf-name: object[]

VRF name of the target

object
name: string

VRF Name

Example
{
  "target": [
    {
      "target-addresses": {
        "target-address": [
          {
            "ip-address": "string"
          }
        ]
      },
      "target-list-name": "string",
      "vrf-names": {
        "vrf-name": [
          {
            "name": "string"
          }
        ]
      }
    }
  ]
}

a1_vrf-names_schema:

List of VRF Name for a target list

vrf-name: object[]

VRF name of the target

object
name: string

VRF Name

Example
{
  "vrf-name": [
    {
      "name": "string"
    }
  ]
}

a1_vrf-name_schema:

name: string

VRF Name

Example
{
  "name": "string"
}

a1_target-addresses_schema:

SNMP Target address configurations

target-address: object[]

IP Address to be configured for the Target

object
ip-address: string

IPv4/Ipv6 address

Example
{
  "target-address": [
    {
      "ip-address": "string"
    }
  ]
}

a1_target-address_schema:

ip-address: string

IPv4/Ipv6 address

Example
{
  "ip-address": "string"
}

a1_notification_schema:

Enable SNMP notifications

vrrp: object

VRRP-MIB notification configuration

enable: null

Enable VRRP-MIB notifications

snmp: object

SNMP notification configuration

authentication: null

Enable authentication notification

enable: null

Enable SNMP notifications

warm-start: null

Enable warm start notification

cold-start: null

Enable cold start notification

Example
{
  "vrrp": {
    "enable": [ null ]
  },
  "snmp": {
    "authentication": [ null ],
    "enable": [ null ],
    "warm-start": [ null ],
    "cold-start": [ null ]
  }
}

a1_correlator_schema:

Configure properties of the trap correlator

rules: object

Table of configured rules

rule: object[]

Rule name

non-root-causes: object

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

timeout: integer

Timeout (time to wait for active correlation) in milliseconds

range:"1..600000" units:"millisecond"
root-causes: object

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

name: string

Rule name

rule-sets: object

Table of configured rulesets

rule-set: object[]

Ruleset name

name: string

Ruleset name

rulenames: object

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

buffer-size: integer

Configure size of the correlator buffer

range:"1024..2147483647" units:"byte"
Example
{
  "rules": {
    "rule": [
      {
        "non-root-causes": {
          "non-root-cause": [
            {
              "oid": "string",
              "created": [ null ],
              "var-binds": {
                "var-bind": [
                  {
                    "oid": "string",
                    "match": {
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "timeout": "integer",
        "root-causes": {
          "root-cause": [
            {
              "oid": "string",
              "created": [ null ],
              "var-binds": {
                "var-bind": [
                  {
                    "oid": "string",
                    "match": {
                      "index": "string",
                      "value": "string"
                    }
                  }
                ]
              }
            }
          ]
        },
        "name": "string",
        "applied-to": {
          "all": [ null ],
          "hosts": {
            "host": [
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "rule-sets": {
    "rule-set": [
      {
        "name": "string",
        "rulenames": {
          "rulename": [
            {
              "rulename": "string"
            }
          ]
        },
        "applied-to": {
          "all": [ null ],
          "hosts": {
            "host": [
              {
                "port": "string",
                "ip-address": "string"
              }
            ]
          }
        }
      }
    ]
  },
  "buffer-size": "integer"
}

a1_rules_schema:

Table of configured rules

rule: object[]

Rule name

non-root-causes: object

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

timeout: integer

Timeout (time to wait for active correlation) in milliseconds

range:"1..600000" units:"millisecond"
root-causes: object

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

name: string

Rule name

Example
{
  "rule": [
    {
      "non-root-causes": {
        "non-root-cause": [
          {
            "oid": "string",
            "created": [ null ],
            "var-binds": {
              "var-bind": [
                {
                  "oid": "string",
                  "match": {
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "timeout": "integer",
      "root-causes": {
        "root-cause": [
          {
            "oid": "string",
            "created": [ null ],
            "var-binds": {
              "var-bind": [
                {
                  "oid": "string",
                  "match": {
                    "index": "string",
                    "value": "string"
                  }
                }
              ]
            }
          }
        ]
      },
      "name": "string",
      "applied-to": {
        "all": [ null ],
        "hosts": {
          "host": [
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

a1_rule_schema:

non-root-causes: object

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

timeout: integer

Timeout (time to wait for active correlation) in milliseconds

range:"1..600000" units:"millisecond"
root-causes: object

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

name: string

Rule name

Example
{
  "non-root-causes": {
    "non-root-cause": [
      {
        "oid": "string",
        "created": [ null ],
        "var-binds": {
          "var-bind": [
            {
              "oid": "string",
              "match": {
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "timeout": "integer",
  "root-causes": {
    "root-cause": [
      {
        "oid": "string",
        "created": [ null ],
        "var-binds": {
          "var-bind": [
            {
              "oid": "string",
              "match": {
                "index": "string",
                "value": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "name": "string",
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

a1_root-causes_schema:

Table of configured rootcause (only one entry allowed)

root-cause: object[]

The rootcause - maximum of one can be configured per rule

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

Example
{
  "root-cause": [
    {
      "oid": "string",
      "created": [ null ],
      "var-binds": {
        "var-bind": [
          {
            "oid": "string",
            "match": {
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

a1_root-cause_schema:

oid: string

OID of rootcause trap (dotted decimal)

created: null

Create rootcause

Example
{
  "oid": "string",
  "created": [ null ],
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

a1_var-binds_schema:

Varbinds to match

var-bind: object[]

Varbind match conditions

object
oid: string

OID of varbind (dotted decimal)

match: object

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "var-bind": [
    {
      "oid": "string",
      "match": {
        "index": "string",
        "value": "string"
      }
    }
  ]
}

a1_var-bind_schema:

oid: string

OID of varbind (dotted decimal)

match: object

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "oid": "string",
  "match": {
    "index": "string",
    "value": "string"
  }
}

a1_match_schema:

VarBind match conditions

index: string

Regular Expression to match index

value: string

Regular Expression to match value

Example
{
  "index": "string",
  "value": "string"
}

a1_non-root-causes_schema:

Table of configured non-rootcause

non-root-cause: object[]

A non-rootcause

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

Example
{
  "non-root-cause": [
    {
      "oid": "string",
      "created": [ null ],
      "var-binds": {
        "var-bind": [
          {
            "oid": "string",
            "match": {
              "index": "string",
              "value": "string"
            }
          }
        ]
      }
    }
  ]
}

a1_non-root-cause_schema:

oid: string

OID of nonrootcause trap (dotted decimal)

created: null

Create nonrootcause

Example
{
  "oid": "string",
  "created": [ null ],
  "var-binds": {
    "var-bind": [
      {
        "oid": "string",
        "match": {
          "index": "string",
          "value": "string"
        }
      }
    ]
  }
}

a1_applied-to_schema:

Applied to the Rule or Ruleset

all: null

Apply to all of the device

hosts: object

Table of configured hosts to apply rules to

host: object[]

A destination host

object
port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "all": [ null ],
  "hosts": {
    "host": [
      {
        "port": "string",
        "ip-address": "string"
      }
    ]
  }
}

a1_hosts_schema:

Table of configured hosts to apply rules to

host: object[]

A destination host

object
port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "host": [
    {
      "port": "string",
      "ip-address": "string"
    }
  ]
}

a1_host_schema:

port: string

Port (specify 162 for default)

ip-address: string

IP address

Example
{
  "port": "string",
  "ip-address": "string"
}

a1_rule-sets_schema:

Table of configured rulesets

rule-set: object[]

Ruleset name

name: string

Ruleset name

rulenames: object

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

Example
{
  "rule-set": [
    {
      "name": "string",
      "rulenames": {
        "rulename": [
          {
            "rulename": "string"
          }
        ]
      },
      "applied-to": {
        "all": [ null ],
        "hosts": {
          "host": [
            {
              "port": "string",
              "ip-address": "string"
            }
          ]
        }
      }
    }
  ]
}

a1_rule-set_schema:

name: string

Ruleset name

rulenames: object

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

Example
{
  "name": "string",
  "rulenames": {
    "rulename": [
      {
        "rulename": "string"
      }
    ]
  },
  "applied-to": {
    "all": [ null ],
    "hosts": {
      "host": [
        {
          "port": "string",
          "ip-address": "string"
        }
      ]
    }
  }
}

a1_rulenames_schema:

Table of configured rulenames

rulename: object[]

A rulename

object
rulename: string

Rule name

Example
{
  "rulename": [
    {
      "rulename": "string"
    }
  ]
}

a1_rulename_schema:

rulename: string

Rule name

Example
{
  "rulename": "string"
}

a1_bulk-stats_schema:

SNMP bulk stats configuration commands

memory: integer

per process memory limit in kilo bytes

range:"100..200000" units:"kilobyte"
transfers: object

Periodicity for the transfer of bulk data in minutes

transfer: object[]

Name of bulk transfer

object
retry: integer

Number of transmission retries

range:"0..100"
transfer-schemas: object

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

format: string schema-ascii, bulk-ascii, bulk-binary

Format of the bulk data file

interval: integer

Periodicity for the transfer of bulk data in minutes

units:"millisecond"
primary: string

FTP or rcp or TFTP can be used for file transfer

buffer-size: integer

Bulkstat data file maximum size in bytes

range:"1024..2147483647" units:"byte"
enable: null

Start Data Collection for this Configuration

transfer-name: string

Name of bulk transfer

retain: integer

Retention period in minutes

range:"0..20000" units:"minute"
type: null

Configure transfer list name

secondary: string

FTP or rcp or TFTP can be used for file transfer

objects: object

Configure an Object List

object: object[]

Name of the object List

object
object-list-name: string

Name of the object List

objects: object

Configure an object List

object: object[]

Object name or OID

object
oid: string

Object name or OID

type: null

Configure object list name

schemas: object

Configure schema definition

schema: object[]

The name of the Schema

object
schema-name: string

The name of the schema

instance: object

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

type: null

Configure schema name

schema-object-list: string

Name of an object List

poll-interval: integer

Periodicity for polling of objects in this schema in minutes

range:"1..20000" units:"minute"
Example
{
  "memory": "integer",
  "transfers": {
    "transfer": [
      {
        "retry": "integer",
        "transfer-schemas": {
          "transfer-schema": [
            {
              "schema-name": "string"
            }
          ]
        },
        "format": "string",
        "interval": "integer",
        "primary": "string",
        "buffer-size": "integer",
        "enable": [ null ],
        "transfer-name": "string",
        "retain": "integer",
        "type": [ null ],
        "secondary": "string"
      }
    ]
  },
  "objects": {
    "object": [
      {
        "object-list-name": "string",
        "objects": {
          "object": [
            {
              "oid": "string"
            }
          ]
        },
        "type": [ null ]
      }
    ]
  },
  "schemas": {
    "schema": [
      {
        "schema-name": "string",
        "instance": {
          "end": "string",
          "sub-interface": "boolean",
          "start": "string",
          "max": "integer",
          "instance": "string",
          "type": "string"
        },
        "type": [ null ],
        "schema-object-list": "string",
        "poll-interval": "integer"
      }
    ]
  }
}

a1_schemas_schema:

Configure schema definition

schema: object[]

The name of the Schema

object
schema-name: string

The name of the schema

instance: object

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

type: null

Configure schema name

schema-object-list: string

Name of an object List

poll-interval: integer

Periodicity for polling of objects in this schema in minutes

range:"1..20000" units:"minute"
Example
{
  "schema": [
    {
      "schema-name": "string",
      "instance": {
        "end": "string",
        "sub-interface": "boolean",
        "start": "string",
        "max": "integer",
        "instance": "string",
        "type": "string"
      },
      "type": [ null ],
      "schema-object-list": "string",
      "poll-interval": "integer"
    }
  ]
}

a1_schema_schema:

schema-name: string

The name of the schema

instance: object

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

type: null

Configure schema name

schema-object-list: string

Name of an object List

poll-interval: integer

Periodicity for polling of objects in this schema in minutes

range:"1..20000" units:"minute"
Example
{
  "schema-name": "string",
  "instance": {
    "end": "string",
    "sub-interface": "boolean",
    "start": "string",
    "max": "integer",
    "instance": "string",
    "type": "string"
  },
  "type": [ null ],
  "schema-object-list": "string",
  "poll-interval": "integer"
}

a1_instance_schema:

Object instance information

end: string

End Instance OID for repetition

sub-interface: boolean

Include all the subinterface

start: string

Start Instance OID for repetition

max: integer

Max value of Instance repetition

instance: string

Instance of the schema

type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid

Type of the instance

Example
{
  "end": "string",
  "sub-interface": "boolean",
  "start": "string",
  "max": "integer",
  "instance": "string",
  "type": "string"
}

a1_objects_schema:

Configure an object List

object: object[]

Object name or OID

object
oid: string

Object name or OID

Example
{
  "object": [
    {
      "oid": "string"
    }
  ]
}

a1_object_schema:

oid: string

Object name or OID

Example
{
  "oid": "string"
}

a1_transfers_schema:

Periodicity for the transfer of bulk data in minutes

transfer: object[]

Name of bulk transfer

object
retry: integer

Number of transmission retries

range:"0..100"
transfer-schemas: object

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

format: string schema-ascii, bulk-ascii, bulk-binary

Format of the bulk data file

interval: integer

Periodicity for the transfer of bulk data in minutes

units:"millisecond"
primary: string

FTP or rcp or TFTP can be used for file transfer

buffer-size: integer

Bulkstat data file maximum size in bytes

range:"1024..2147483647" units:"byte"
enable: null

Start Data Collection for this Configuration

transfer-name: string

Name of bulk transfer

retain: integer

Retention period in minutes

range:"0..20000" units:"minute"
type: null

Configure transfer list name

secondary: string

FTP or rcp or TFTP can be used for file transfer

Example
{
  "transfer": [
    {
      "retry": "integer",
      "transfer-schemas": {
        "transfer-schema": [
          {
            "schema-name": "string"
          }
        ]
      },
      "format": "string",
      "interval": "integer",
      "primary": "string",
      "buffer-size": "integer",
      "enable": [ null ],
      "transfer-name": "string",
      "retain": "integer",
      "type": [ null ],
      "secondary": "string"
    }
  ]
}

a1_transfer_schema:

retry: integer

Number of transmission retries

range:"0..100"
transfer-schemas: object

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

format: string schema-ascii, bulk-ascii, bulk-binary

Format of the bulk data file

interval: integer

Periodicity for the transfer of bulk data in minutes

units:"millisecond"
primary: string

FTP or rcp or TFTP can be used for file transfer

buffer-size: integer

Bulkstat data file maximum size in bytes

range:"1024..2147483647" units:"byte"
enable: null

Start Data Collection for this Configuration

transfer-name: string

Name of bulk transfer

retain: integer

Retention period in minutes

range:"0..20000" units:"minute"
type: null

Configure transfer list name

secondary: string

FTP or rcp or TFTP can be used for file transfer

Example
{
  "retry": "integer",
  "transfer-schemas": {
    "transfer-schema": [
      {
        "schema-name": "string"
      }
    ]
  },
  "format": "string",
  "interval": "integer",
  "primary": "string",
  "buffer-size": "integer",
  "enable": [ null ],
  "transfer-name": "string",
  "retain": "integer",
  "type": [ null ],
  "secondary": "string"
}

a1_transfer-schemas_schema:

Schema that contains objects to be collected

transfer-schema: object[]

Schema that contains objects to be collected

object
schema-name: string

Schema that contains objects to be collected

Example
{
  "transfer-schema": [
    {
      "schema-name": "string"
    }
  ]
}

a1_transfer-schema_schema:

schema-name: string

Schema that contains objects to be collected

Example
{
  "schema-name": "string"
}

a1_default-community-maps_schema:

Container class to hold unencrpted community map

default-community-map: object[]

Unencrpted SNMP community map name

object
security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "default-community-map": [
    {
      "security": "string",
      "community-name": "string",
      "context": "string",
      "target-list": "string"
    }
  ]
}

a1_default-community-map_schema:

security: string

SNMP Security Name

community-name: string

SNMP community map

context: string

SNMP Context Name

target-list: string

target list name

Example
{
  "security": "string",
  "community-name": "string",
  "context": "string",
  "target-list": "string"
}

a1_overload-control_schema:

Set overload control params for handling incoming messages

drop-time: integer

Drop time in seconds for incoming queue (default 1 sec)

range:"0..300" units:"second"
throttle-rate: integer

Throttle time in milliseconds for incoming queue (default 500 msec)

range:"0..1000" units:"millisecond"
Example
{
  "drop-time": "integer",
  "throttle-rate": "integer"
}

a1_timeouts_schema:

SNMP timeouts

duplicates: integer

Duplicate request feature timeout

range:"0..20" units:"second" default:"1"
threshold: integer

Threshold request feature timeout

range:"0..100000" units:"second" default:"50000"
pdu-stats: integer

SNMP pdu statistics timeout

range:"1..10" units:"second" default:"2"
in-qdrop: integer

incoming queue drop feature timeout

range:"0..20" units:"second" default:"10"
subagent: integer

Sub-Agent Request timeout

range:"1..20" units:"second" default:"10"
Example
{
  "duplicates": "integer",
  "threshold": "integer",
  "pdu-stats": "integer",
  "in-qdrop": "integer",
  "subagent": "integer"
}

a1_users_schema:

Define a user who can access the SNMP engine

user: object[]

Name of the user

object
v6acl-type: string ipv4, ipv6

Access-list type

group-name: string

Group to which the user belongs

v6-access-list: string

Ipv6 Access-list name

priv-algorithm: string none, des, 3des, aes128, aes192, aes256

The algorithm used des56 or aes128 or aes192or aes256 or 3des

owner: string sdr-owner, system-owner

The system access either SDROwner or SystemOwner

v4acl-type: string ipv4, ipv6

Access-list type

privacy-password: string

The privacy password

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

user-name: string

Name of the user

algorithm: string none, md5, sha

The algorithm used md5 or sha

privacy-password-configured: null

Flag to indicate that the privacy password is configured for version 3

authentication-password: string

The authentication password

version: string v1, v2c, v3

SNMP version to be used. v1,v2c or v3

v4-access-list: string

Ipv4 Access-list name

authentication-password-configured: null

Flag to indicate that authentication password is configred for version 3

Example
{
  "user": [
    {
      "v6acl-type": "string",
      "group-name": "string",
      "v6-access-list": "string",
      "priv-algorithm": "string",
      "owner": "string",
      "v4acl-type": "string",
      "privacy-password": "string",
      "remote-address": "string",
      "port": "string",
      "user-name": "string",
      "algorithm": "string",
      "privacy-password-configured": [ null ],
      "authentication-password": "string",
      "version": "string",
      "v4-access-list": "string",
      "authentication-password-configured": [ null ]
    }
  ]
}

a1_user_schema:

v6acl-type: string ipv4, ipv6

Access-list type

group-name: string

Group to which the user belongs

v6-access-list: string

Ipv6 Access-list name

priv-algorithm: string none, des, 3des, aes128, aes192, aes256

The algorithm used des56 or aes128 or aes192or aes256 or 3des

owner: string sdr-owner, system-owner

The system access either SDROwner or SystemOwner

v4acl-type: string ipv4, ipv6

Access-list type

privacy-password: string

The privacy password

remote-address: string

IP address of remote SNMP entity

port: string

UDP port number

user-name: string

Name of the user

algorithm: string none, md5, sha

The algorithm used md5 or sha

privacy-password-configured: null

Flag to indicate that the privacy password is configured for version 3

authentication-password: string

The authentication password

version: string v1, v2c, v3

SNMP version to be used. v1,v2c or v3

v4-access-list: string

Ipv4 Access-list name

authentication-password-configured: null

Flag to indicate that authentication password is configred for version 3

Example
{
  "v6acl-type": "string",
  "group-name": "string",
  "v6-access-list": "string",
  "priv-algorithm": "string",
  "owner": "string",
  "v4acl-type": "string",
  "privacy-password": "string",
  "remote-address": "string",
  "port": "string",
  "user-name": "string",
  "algorithm": "string",
  "privacy-password-configured": [ null ],
  "authentication-password": "string",
  "version": "string",
  "v4-access-list": "string",
  "authentication-password-configured": [ null ]
}

a1_vrfs_schema:

SNMP VRF configuration commands

vrf: object[]

VRF name

name: string

VRF name

Example
{
  "vrf": [
    {
      "name": "string",
      "context-mappings": {
        "context-mapping": [
          {
            "context-mapping-name": "string",
            "vrf-name": "string",
            "topology-name": "string",
            "context": "string",
            "instance-name": "string"
          }
        ]
      }
    }
  ]
}

a1_vrf_schema:

name: string

VRF name

Example
{
  "name": "string",
  "context-mappings": {
    "context-mapping": [
      {
        "context-mapping-name": "string",
        "vrf-name": "string",
        "topology-name": "string",
        "context": "string",
        "instance-name": "string"
      }
    ]
  }
}

a1_trap-hosts_schema:

Specify hosts to receive SNMP notifications

trap-host: object[]

Specify hosts to receive SNMP notifications

object
encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-host: object

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

ip-address: string

IP address of SNMP notification host

default-user-communities: object

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "trap-host": [
    {
      "encrypted-user-communities": {
        "encrypted-user-community": [
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      },
      "inform-host": {
        "inform-encrypted-user-communities": {
          "inform-encrypted-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        },
        "inform-user-communities": {
          "inform-user-community": [
            {
              "port": "string",
              "version": "string",
              "community-name": "string",
              "basic-trap-types": "integer",
              "advanced-trap-types2": "integer",
              "security-level": "string",
              "advanced-trap-types1": "integer"
            }
          ]
        }
      },
      "ip-address": "string",
      "default-user-communities": {
        "default-user-community": [
          {
            "port": "string",
            "version": "string",
            "community-name": "string",
            "basic-trap-types": "integer",
            "advanced-trap-types2": "integer",
            "security-level": "string",
            "advanced-trap-types1": "integer"
          }
        ]
      }
    }
  ]
}

a1_trap-host_schema:

encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-host: object

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

ip-address: string

IP address of SNMP notification host

default-user-communities: object

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "encrypted-user-communities": {
    "encrypted-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  "inform-host": {
    "inform-encrypted-user-communities": {
      "inform-encrypted-user-community": [
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    },
    "inform-user-communities": {
      "inform-user-community": [
        {
          "port": "string",
          "version": "string",
          "community-name": "string",
          "basic-trap-types": "integer",
          "advanced-trap-types2": "integer",
          "security-level": "string",
          "advanced-trap-types1": "integer"
        }
      ]
    }
  },
  "ip-address": "string",
  "default-user-communities": {
    "default-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

a1_encrypted-user-communities_schema:

Container class for defining Clear/encrypt communities for a trap host

encrypted-user-community: object[]

Clear/Encrypt Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "encrypted-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a1_encrypted-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a1_inform-host_schema:

Container class for defining notification type for a Inform host

inform-encrypted-user-communities: object

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

inform-user-communities: object

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "inform-encrypted-user-communities": {
    "inform-encrypted-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  },
  "inform-user-communities": {
    "inform-user-community": [
      {
        "port": "string",
        "version": "string",
        "community-name": "string",
        "basic-trap-types": "integer",
        "advanced-trap-types2": "integer",
        "security-level": "string",
        "advanced-trap-types1": "integer"
      }
    ]
  }
}

a1_inform-user-communities_schema:

Container class for defining communities for a inform host

inform-user-community: object[]

Unencrpted Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "inform-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a1_inform-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a1_inform-encrypted-user-communities_schema:

Container class for defining Clear/encrypt communities for a inform host

inform-encrypted-user-community: object[]

Clear/Encrypt Community name associated with a inform host

object
port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "inform-encrypted-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a1_inform-encrypted-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v2c/v3

community-name: string

SNMPv2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a1_default-user-communities_schema:

Container class for defining communities for a trap host

default-user-community: object[]

Unencrpted Community name associated with a trap host

object
port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "default-user-community": [
    {
      "port": "string",
      "version": "string",
      "community-name": "string",
      "basic-trap-types": "integer",
      "advanced-trap-types2": "integer",
      "security-level": "string",
      "advanced-trap-types1": "integer"
    }
  ]
}

a1_default-user-community_schema:

port: string

UDP port number

version: string

SNMP Version to be used v1/v2c/v3

community-name: string

SNMPv1/v2c community string or SNMPv3 user

basic-trap-types: integer

Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps

advanced-trap-types2: integer

Number to signify the feature traps that needs to be setvalue should always to set as 0

security-level: string no-authentication, authentication, privacy

Security level to be used noauth/auth/priv

advanced-trap-types1: integer

Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used

Example
{
  "port": "string",
  "version": "string",
  "community-name": "string",
  "basic-trap-types": "integer",
  "advanced-trap-types2": "integer",
  "security-level": "string",
  "advanced-trap-types1": "integer"
}

a1_contexts_schema:

List of Context Names

context: object[]

Context Name

object
context-name: string

Context Name

Example
{
  "context": [
    {
      "context-name": "string"
    }
  ]
}

a1_context_schema:

context-name: string

Context Name

Example
{
  "context-name": "string"
}

a1_context-mappings_schema:

List of context names

context-mapping: object[]

Context mapping name

object
context-mapping-name: string

Context mapping name

vrf-name: string

VRF name associated with the context

topology-name: string

Topology name associated with the context

context: string vrf, bridge, ospf, ospfv3

SNMP context feature type

instance-name: string

OSPF protocol instance

Example
{
  "context-mapping": [
    {
      "context-mapping-name": "string",
      "vrf-name": "string",
      "topology-name": "string",
      "context": "string",
      "instance-name": "string"
    }
  ]
}

a1_context-mapping_schema:

context-mapping-name: string

Context mapping name

vrf-name: string

VRF name associated with the context

topology-name: string

Topology name associated with the context

context: string vrf, bridge, ospf, ospfv3

SNMP context feature type

instance-name: string

OSPF protocol instance

Example
{
  "context-mapping-name": "string",
  "vrf-name": "string",
  "topology-name": "string",
  "context": "string",
  "instance-name": "string"
}

a1_groups_schema:

Define a User Security Model group

group: object[]

Name of the group

object
name: string

Name of the group

write-view: string

write view name

snmp-version: string v1, v2c, v3

snmp version

context-name: string

Context name

security-model: string no-authentication, authentication, privacy

security model like auth/noAuth/Priv applicable for v3

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

read-view: string

read view name

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

notify-view: string

notify view name

Example
{
  "group": [
    {
      "name": "string",
      "write-view": "string",
      "snmp-version": "string",
      "context-name": "string",
      "security-model": "string",
      "v6acl-type": "string",
      "v6-access-list": "string",
      "read-view": "string",
      "v4acl-type": "string",
      "v4-access-list": "string",
      "notify-view": "string"
    }
  ]
}

a1_group_schema:

name: string

Name of the group

write-view: string

write view name

snmp-version: string v1, v2c, v3

snmp version

context-name: string

Context name

security-model: string no-authentication, authentication, privacy

security model like auth/noAuth/Priv applicable for v3

v6acl-type: string ipv4, ipv6

Access-list type

v6-access-list: string

Ipv6 Access-list name

read-view: string

read view name

v4acl-type: string ipv4, ipv6

Access-list type

v4-access-list: string

Ipv4 Access-list name

notify-view: string

notify view name

Example
{
  "name": "string",
  "write-view": "string",
  "snmp-version": "string",
  "context-name": "string",
  "security-model": "string",
  "v6acl-type": "string",
  "v6-access-list": "string",
  "read-view": "string",
  "v4acl-type": "string",
  "v4-access-list": "string",
  "notify-view": "string"
}

a1_mib_schema:

mib

Example